O Open Insurance, ou Sistema de Seguros Aberto, é a possibilidade de consumidores de produtos e serviços de seguros, previdência complementar aberta e capitalização permitirem o compartilhamento de suas informações entre diferentes sociedades autorizadas/credenciadas pela Susep, de forma segura, ágil, precisa e conveniente.
Para entregar esses benefícios ao consumidor, o Open Insurance operacionaliza e padroniza o compartilhamento de dados e serviços por meio de abertura e integração de sistemas, com privacidade e segurança.
Este anexo tem como objetivo detalhar quando a versão das APIs do Open Insurance é alterada. Ele poderá ser acessado clicando aqui.
Este anexo tem como objetivo detalhar quando a versão das APIs do Open Insurance é alterada, conforme a classificação da modificação.Ele poderá ser acessado clicando aqui.
Major*: Versão gerada para mudanças de legislação e atualização de documentações oficiais que só poderão ser lançadas com a anuência da SUSEP, por exemplo, v1.0.0 e v2.0.0;
Minor: Versão gerada quando forem realizadas atualizações que descompatibilizam o mercado, mas que não se tratam de versões major, por exemplo, v1.1.0 e v1.2.0;
Patch: Versão gerada quando há correção de bug ou alteração da documentação que não impacta ou descompatibiliza a API (v1.1.1)
OBS: A instituição deve obrigatoriamente refazer a certificação das APIs no Diretório de Participantes conforme release de uma versão major, minor ou patch.
Alteração
Versionamento
Adição de obrigatoriedade de campo
minor
Alteração de pattern que impacta a validação
Retirada de campo
minor
Adição de campo
minor
Ajuste na grafia do campo
minor
Alteraçao do tipo do campo
minor
Diminuição de número de caracteres
minor
Atualizações de REGEX para início de validação de campos antes não validados
minor
Atualização de patterns que não impactam a validação
patch
Retirada de obrigatoriedade de campo
patch
Aumento no número de caracteres
patch
Adição de enum
patch
Ajuste na descrição do campo
patch
Alteração nos exemplos do campo
patch
Atualizações de REGEX que não impactam a validação
patch
Alteração de pattern que não impacta a validação
patch
Retirada de campo não obrigatório
patch
Adição de campo não obrigatório
patch
Retirada da obrigatoriedade de um Campo
patch
Segurança
Introdução - Segurança
Esta seção tem como finalidade auxiliar na auto avaliação aos cumprimentos dos requisitos de segurança da informação relacionados a autorização e autenticação de APIs e End-Users, emissão de certificados digitais e requisitos para o onboarding no Diretório de participantes para as Instituições participantes do Open Insurance.
As instituições participantes do Open Insurance possuem a obrigação de acompanhar a edição e a revogação de eventuais normas com impacto no tema de forma a estar permanentemente em dia com as determinações legais. Compõem, de forma não exaustiva, o rol de atos normativos cuja observância é essencial pelas instituições participantes do Open Insurance:
Além desse guia, foi elaborado um checklist para auxiliar os participantes do Open Insurance a alcançar um nível adequado de Segurança da Informação, esse checklist pode ser baixado em formato Excel a seguir:
As APIs de Open Insurance estão dividas em dois escopos:
open-data
customer-data
Segue, a continuação, um overview das camadas de segurança básicas para atender os contextos Open-data:
Camada
Descrição
Explicação
Física
Firewall
Equipamentos e produtos como filtros, proxys e firewalls direcionados ao controle e segurança da rede física.
Transporte
HTTP - TLS 1.2
Protocolo de criptografia que fornece segurança na comunicação sobre a rede física.
Gestão
API Gateway / Manager
Gateway e Manager para gerenciar a publicação da API com controles de throttling, quotas e outros.
Manual de Segurança
A documentação que detalha os controles técnicos de segurança que serão implementados na arquitetura do Open Insurance junto do conjunto padronizado de regras e requisitos para formação do framework de confiança para acesso de recursos protegidos pode ser acessado aqui
Diretrizes Técnicas de Certificação
Para a entrada segura e assertiva no Ecossistema do Open Insurance Brasil, a Estrutura Inicial disponibilizou um conjunto de ferramentas e infraestrutura para suportar o processo de testes e homologação dos produtos e serviços desenvolvidos pelas Instituições Participantes. Foram disponibilizados ambientes que habilitam ao participante:
Realizar testes da camada de segurança de suas aplicações e posterior certificação dessas aplicações, utilizando a estrutura criada e mantida pela Open ID Foundation (“Motor de Conformidade de Segurança”);
Submeter, ainda em tempo de desenvolvimento, suas implementações das APIs do Open Banking a testes automatizados funcionais (“Motor de Conformidade Funcional”).
Lembramos que uma implementação de versão de API do Open Insurance só poderá ser registrada no ambiente produtivo do Diretório caso tenha sido certificada nos testes de segurança e funcionais.
Todos os detalhes para a execução dos testes e obtenção dos certificados podem ser encontrados no material de orientações do Processo de Certificação. Estes materiais estão em processo contínuo de atualização, podendo sofrer alterações. Qualquer dúvida em relação ao processo, fique à vontade para a submissão de tickets através do Service Desk.
Em sua essência, o Open Finance Brasil é um ecossistema de compartilhamento de dados onde os clientes de bancos e outras instituições financeiras desejam compartilhar suas informações de conta ou dar permissão para que os pagamentos sejam executados em seu nome com serviços de terceiros e o Open Insurance Brasil utiliza os padrões de segurança do Open Finance Brasil.
Há uma série de funções necessárias para vincular qualquer sistema de identificação, autenticação e autorização, independentemente do setor. Todas essas funções são necessárias, mas várias funções podem ser desempenhadas por cada participante. Em geral, o usuário final (“Subject”), está dando a um sistema (“Client”) uma autorização (“Access Token”) para acessar um recurso protegido mantido pelo provedor (“Resource Server”). Isso exige que o Subject e o Client sejam identificados e autenticados e que a autorização seja confirmada.
As regras exatas e os requisitos legais para cada função em um setor específico formam um framework de confiança ("Trust Framework"). Cada ecossistema requer um conjunto padronizado de regras e requisitos legais que abrangem todas as funções e obrigações das interações acima. A combinação de quem fornece qual(is) função(ões), os níveis aos quais eles devem desempenhar essas funções e os padrões pelos quais essas operações devem ser definidas por um framework de confiança específico do setor.
Diferentes frameworks de confiança terão diferentes opções de implementação, mas um framework de confiança comum é um pré-requisito para transformar um ‘setor’ em um ‘ecossistema’. Um framework de confiança comum reduz significativamente a complexidade e custos, aumenta a escalabilidade e a interoperabilidade dentro do setor, bem como abre opções para o tipo de padronização intersetorial que o Open Insurance Brasil está buscando.
Diferentes implementações podem ser definidas para setores, com diferentes prós / contras e custos associados para diferentes participantes. Cada uma das implementações propostas pode ser usada para qualquer setor se os pré-requisitos corretos estiverem em vigor. A solução certa dependerá do apetite e alinhamento de cada conjunto de participantes.
A implementação de um mecanismo comum para o Open Insurance Brasil exigirá um compromisso com a simetria entre os setores para incluir detalhes específicos do setor nos princípios do framework de confiança.
É necessário fazer escolhas técnicas para garantir que qualquer implementação forneça uma base estrita e consistente para ter credibilidade, mas mantenha a flexibilidade para se adaptar às necessidades futuras. Isso implica padrões de código-fonte aberto amplamente disponíveis, amplamente compreendidos e que foram experimentados e testados. Além de habilitar um gama de parceiros e fornecedores que podem apoiar qualquer construção técnica, o que significa que continuará havendo espaço para desenvolvimento comercial de soluções.
Participantes de um Ecossistema de Compartilhamento de Dados
Nos ecossistemas de Open Insurance voltados para o consumidor que estamos considerando, temos três participantes principais:
O cliente (user)
A instituição transmissora de dados (provider), que oferece serviços de seguros
A instituição receptora de dados (TPP - Third Party Provider), que oferece uma proposta de Open Insurance para o cliente:
Em todos os casos a seguir, assumimos:
Um cliente possui uma conta para um serviço principal ou conjunto de recursos numa instituição transmissora de dados
Uma instituição receptora de dados oferece ao cliente uma proposta habilitada por meio do compartilhamento inteligente de dados
O cliente dá consentimento à instituição receptora de dados para fins de entrega dessa proposta
A instituição transmissora de dados tem a obrigação de salvaguardar os dados do cliente, mas também de compartilhá-los quando instruído.
O ecossistema também possui provedores de serviços de confiança, que são entidades que fornecem garantia técnica a ambas instituições (transmissoras e receptoras) de que todos estão autorizados a participar do ecossistema.
Os padrões técnicos necessários para dar suporte ao framework de confiança devem atender todos os requisitos a seguir:
Identificação de todos os participantes do ecossistema
Autenticação quando exigida de todos os participantes entre si
Confirmação de autorização de todos os participantes em um ecossistema de compartilhamento de dados
Os serviços técnicos necessários para suportar um ecossistema devem habilitar todos os requisitos acima em uma base e modo contínuos, isto é, não apenas em um único ponto de registro.
Princípios de Especificação e Requisitos de Alto Nível
O Open Insurance Brasil adotou os seguintes princípios e requisitos de alto nível no que diz respeito às normas técnicas.
Consentimento
Os clientes devem estar sempre no controle de quem tem acesso aos seus dados e para quais fins eles estão sendo usados.
Minimização de dados
Os clientes devem ser capazes de compartilhar apenas os dados de que precisam, pelo tempo que for necessário.
Segurança
Uma modelagem de ameaças foi produzido avaliando todas as fraquezas potenciais nos processos de comunicação.
Todos os pontos fracos identificados foram corrigidos.
Identificação
Todos os participantes devem ter segurança na identificação de todos os atores do ecossistema.
Autenticação
Todos os participantes devem comunicar as etapas que foram executadas para autenticar cada participante no ecossistema e em que nível isso foi executado.
Integridade e não repúdio
Todos os participantes devem ser capazes de provar que as mensagens não foram adulteradas e, na verdade, foram enviadas apenas por um participante legítimo.
Além dos requisitos de alto nível, os seguintes princípios também foram adotados.
Não reinventar a roda, se existir uma especificação que seja adequada para o propósito, amplamente adotada e publicamente disponível, deve-se adotá-la.
Envolver-se com outros órgãos de normalização para aprender com experiências anteriores sobre o que funcionou, o que não funcionou, e o que pode ser feito melhor.
Assegurar o amplo suporte da indústria para garantir o máximo de chances de sucesso e, mais importante, a segurança do cliente.
Solicitar feedback com antecedência e com frequência, reconhecer que serão necessárias várias iterações para desenvolver um padrão.
O framework de confiança que sustenta o ecossistema de compartilhamento de dados, que é o Open Insurance Brasil, é um framework técnico que precisa ser flexível o suficiente para permitir que os participantes e o ecossistema inovem, cresçam e se desenvolvam, enquanto permanecem interoperáveis.
Todos os participantes devem ter certeza de que todos os atores do ecossistema estão lidando com seus dados com segurança tempo todo. Isso requer que todos os participantes testem publicamente seus sistemas quanto à conformidade com as especificações e disponibilizem os resultados de seus testes de conformidade para exame público de outros participantes.
Este é um requisito aplicável à instituições participantes transmissoras e receptoras de dados.
Principais Padrões de Segurança
Estrutura de Autorização OAuth 2.0
O ecossistema de compartilhamento de dados definido pelo Brasil consiste em muitos padrões diferentes, todos girando em torno de conceitos, funções e obrigações que foram tecnicamente definidos no OAuth 2.0 Authorization Framework.
A estrutura de autorização OAuth 2.0 permite uma aplicação de terceiros (third-party application) obter acesso limitado a um serviço HTTP, seja em nome do proprietário de recurso (resource owner) por meio da orquestração de uma interação de aprovação entre o proprietário do recurso e o serviço HTTP, ou permitindo a aplicação de terceiros obter acesso em seu próprio nome.
A especificação base OAuth 2.0 não fornece, por si só, informações suficientes para atender a todas as necessidades definidas pelo framework de confiança do Open Insurance Brasil. Mais notavelmente, não possui uma maneira de transmitir informações de identidade do cliente em um formato padronizado de uma instituição transmissora para uma receptora, e os mecanismos de autenticação que foram definidos na especificação original não são seguros o suficiente para atender aos requisitos de uma indústria altamente regulamentada.
OpenID Connect - A Camada de Identidade para a Internet
Este perfil herda todas as obrigações do OAuth 2.0
OpenID Connect é um conjunto de especificações simplificadas que fornecem uma estrutura para interações de identidade por meio de APIs do tipo REST. A implementação mais simples do OpenID Connect permite que clients de todos os tipos, incluindo baseados em navegador, celulares e clients javascript, solicitem e recebam informações sobre identidades e sessões atualmente autenticadas. O conjunto de especificações é extensível, permitindo que os participantes também suportem, opcionalmente, criptografia de dados de identidade, descoberta do OpenID Provider e gerenciamento avançado de sessão, incluindo logout.
O grupo de trabalho OpenID Foundations Connect tem sido o guardião do Padrão de Identidade “de fato” da Internet por muitos anos, trabalhando em várias especificações que se baseiam no framework de autorização OAuth 2.0, adicionando recursos e requisitos de suporte para melhorar a segurança do framework em si.
Open ID Connect Core: é um perfil do OAuth 2.0, o que significa que herda todos os requisitos e obrigações do OAuth 2.0, mas define o conceito de um id_token e introduz novos mecanismos de autenticação.
Open ID Connect Discovery: apresenta o conceito de um documento de descoberta usado por OpenID Connect (OIDC) Providers para anunciar como os clients OAuth 2.0 podem se comunicar com eles e quais recursos e opções o OIDC Provider oferece suporte.
RFC7591: além de definir o processo de registro dinâmico de clients OAuth, esta especificação apresenta o conceito de Software Statement (“Declaração de Software”), que pode ser usada para fornecer informações sobre um client que é atestado por um serviço de terceiros. Outros atributos de metadados também são definidos no OpenID Connect Registration Specification:
Esta especificação define mecanismos para registrar dinamicamente clients OAuth 2.0 com Authorization Servers (servidores de autorização). Pedidos de registro enviam um conjunto de valores de metadados do client desejado para o Authorization Server. As respostas de registro resultantes retornam um client identifier para ser usado no Authorization Server e os valores de metadados registrados para o client. O client pode então usar esta informação de registro para se comunicar com o Authorization Server usando o protocolo OAuth 2.0. Esta especificação também define um conjunto de campos de metadados do client e valores para os clients usarem durante o registro.
RFC7592: Esta especificação define métodos de gerenciamento de dynamic client registration (registros de cliente dinâmico) do OAuth 2.0 para casos de uso em que as propriedades de um client registrado necessitam ser alteradas durante a vida do client.
As especificações acima são especificações básicas cuja leitura obrigatória sustenta o framework de confiança do Open Insurance Brasil. Entretanto, eles ainda são insuficientes para atender a todos os requisitos e princípios descritos anteriormente.
OpenID Financial Grade 1.0: Baseline
Este perfil herda todas as obrigações do OpenID Connect Core
Reconhecendo as ameaças e riscos restantes que não foram tratados pelo OpenID Connect Core, o grupo de trabalho Financial Grade tem como foco criar uma especificação que visa identificar e endereçar os pontos fracos na especificação OpenID Connect, essencialmente criando um perfil para casos de uso que exigem alto nível segurança.
O perfil Baseline foi originalmente planejado para ser mais facilmente implementado por clients e OpenID Providers às custas de alguns elementos de segurança e, como tal, não oferece o mesmo grau de proteção contra violação de solicitação e resposta.
OpenID Financial Grade 1.0: Avançado
Este perfil herda todas as obrigações do OpenID FAPI 1.0: Baseline
O FAPI 1.0: Advanced profile é atual padrão ouro para API Security, fornecendo um framework de especificação que foi usado como ponto de partida para a criação de uma especificação para o Open Insurance Brasil.
Este padrão especifica um perfil de segurança avançado do OAuth que é adequado para ser usado para proteger APIs com alto risco inerente. Os exemplos incluem APIs que dão acesso a dados altamente confidenciais ou que podem ser usados para acionar transações financeiras (por exemplo, início de pagamento). Este padrão especifica os controles contra ataques, como: violação de solicitação de autorização, violação de resposta de autorização, incluindo injeção de código, injeção de estado e phishing de solicitação de token.
Sobre o uso de JARM
O suporte ao JARM é opcional aos transmissores e detentores de contas (ASPSP) e, portanto, as instituições que optarem pelo uso do JARM devem, no processo de certificação de segurança, atestar também o suporte a outro profile que não considere o uso do padrão JARM, ou seja, deve também se certificar com um dos profiles listados na tabela a seguir.
Perfil da certificação OIDF
BR-OB Adv. OP w/ MTLS
BR-OB Adv. OP w/ Private Key
BR-OB Adv. OP w/ MTLS, PAR
BR-OB Adv. OP w/ Private Key, PAR
Guia do Usuário para Entidades Transmissoras de Dados
1.0 Registrando um Participante
1.1 Visão Geral do Diretório
Os serviços do framework de confiança providos pelo Open Insurance Brasil fornecem todos os serviços de descoberta necessários para que instituiçoes transmissores e receptoras interajam entre si, sem que seja preciso validar individualmente a autenticidade de cada participante.
Um Authorization Server ou AS, conforme definido por RFC 6749 - The OAuth 2.0 Authorization Framework, executa várias funções em um ecossistema de compartilhamento de dados como o Open Insurance Brasil. Antes de prosseguir, certifique-se de que os conceitos de funções e responsabilidades definidos na RFC original sejam bem compreendidos. Além disso, certifique-se de que os conceitos, funções e responsabilidades definidos no OpenID Connect Core e como eles estendem os conceitos definidos no RFC 6749 são igualmente bem compreendidos.
1.2 Registrando um Authorization Server e OpenID Provider
As seguradoras, geralmente grandes seguradoras, não serão uma entidade única do ponto de vista das operações de tecnologia. Eles podem ter marcas, segurança e infraestrutura de TI diferentes para diferentes segmentos de clientes, ou podem ter alguma infraestrutura de TI que ofereça suporte a várias marcas ou segmentos de clientes. Isso significa que o ecossistema técnico precisa ser flexível o suficiente para suportar uma ampla variedade de implantações de infraestrutura de seguradoras, garantindo que os serviços necessários possam ser descobertos por clientes de instituições receptoras que precisam interagir com ele.
Um modelo flexível para anunciar serviços de autenticação / autorização e os recursos protegidos pelo AuthN e AuthZ é suportado pelo Diretório.
Customer Friendly Name - Será exibido aos clientes pelas instituições receptoras, e já deve ser reconhecido pelos clientes da seguradora.
Customer Friendly Logo - Será exibido aos clientes pelos instituições receptoras para auxiliar no reconhecimento da marca.
Description - Isso pode ser exibido aos clientes pelas instituições receptoras para auxiliar no reconhecimento da marca.
Terms of Service - Este é um link para os Termos de Serviço da seguradora, que podem ser incluídos pelas instituições receptoras.
Notification WebHook - Authorization Servers podem registrar um WebHook que receberá atualizações por push sobre as alterações dos participantes, seus softwares ou certificados.
OpenID Well Known Document Uri - Link para o documento de descoberta do Authorization Server.
Uma seguradora pode optar por ter um Authorization Server ou muitos, desde que satisfaça os seguintes requisitos:
Um cliente pode reconhecer o Authorization Server como um local com o qual normalmente faria interação com a sua seguradora.
O Authorization Server pode emitir tokens para os recursos e serviços que um cliente ou insituição receptora está procurando.
O Authorization Server das instituições transmissoras/detentoras de contas que atenda mais de uma marca deve aceitar mais de um cadastro (criação de client_ids) para um mesmo software statement. Caso a solução de Authorization Server não suporte este comportamento, deverá ser adequado para suportar múltiplas marcas e o cadastramento das marcas no diretório deverá sofrer apontamento de acordo com cada marca.
1.3 Registrando Recursos
Depois que uma seguradora registra um Authorization Server, ela precisa anunciar para quais recursos, APIs ou serviços ele pode fornecer autorização.
No exemplo acima, a Seguros Incríveis está anunciando dois serviços que devem ser reconhecidos pelos clientes. “Seguros Incríveis - Empresas" e “Seguros Incríveis". Estes podem ou não estar diretamente relacionados a “Marcas”, pois seguradoras diferentes podem precisar anunciar serviços de autenticação diferentes, mesmo dentro de uma submarca.
Além disso, a seguradora anuncia quais recursos cada um dos servidores de autorização está protegendo ou oferecendo. No exemplo acima, a Seguros Incríveis é compatível com a versão 1 e a versão 2 da API de seguros de automóveis, e o “Amazing Insurances” tem dois sistemas separados de consentimento e informações dos clientes de seguros.
Anunciar corretamente quais recursos são oferecidos por cada servidor é importante para atingir a escala prevista pelo Open Insurance Brasil, além de ser fundamental para garantir que os clientes possam identificar sua seguradora facilmente e que as instituições receptoras possam encaminhar os clientes para o Authorization Server correto com base nos recursos protegidos por cada serviço.
2.0 Validando uma Solicitação de Registro de Cliente
Usando o OpenID Connect Discovery e a especificação de Dynamic Client Registration (DCR) do Open Insurance Brasil. Uma instituição receptora pode registrar seu aplicativo em cada um dos Authorization Servers disponíveis no ecossistema.
2.1 Registro OpenID Connect e OAuth 2.0 Dynamic Client Registration
Guia do Usuário para Instituições Receptores de Dados
1.0 Registrando um Aplicativo
Em um alto nível, as seguintes etapas principais são necessárias para integrar um novo aplicativo no ecossistema Open Insurance Brasil.
Cadastre sua organização no Diretório de Participantes (Interface do Usuário)
Cadastre seu aplicativo no Diretório de Participantes (Interface do Usuário)
Obtenha credenciais para sua aplicação junto à uma autoridade certificadora ICP-Brasi)(fora do escopo deste documento)
Registre suas credenciais para o seu aplicativo no Diretório de Participantes (Interface do Usuário)
Identifique provedores de informações de conta ou serviços de pagamento de interesse dos clientes de seu aplicativo, pesquisando o Diretório de Participantes (API)
Registre seu aplicativo com cada provedor (API)
1.1 Diagrama de Sequência
1.2 Visão Geral do Diretório
O framework de confiança do Open Insurance Brasil fornece todos os serviços de descoberta necessários para que instituições participantes (receptoras e transmissoras de dados, iniciadoras de serviçoes de seguros) interajam entre si sem serem obrigadas a validarem a autenticidade de identidades, autorizações, Apps, APIs ou credenciais para acessos por aplicativos uns dos outros. Além disso, fornece um único registro de todas propostas ao consumidor sendo oferecidas no mercado e um único ambiente de controle para as autoridades regulatórias que concedem permissões para gerenciar participantes dentro do ecossistema.
O framework de confiança não tem visibilidade ou visão das interações que ocorrem entre instituições participantes receptoras ou transmissoras de dados. Ele é projetado para fornecer confiança e garantia de identidade e autorização apenas. Ele não se enquadra no fluxo de comunicação entre um consumidor e um provedor e não tem conhecimento ou visibilidade de quaisquer dados do cliente. Este modelo de framework de confiança é conhecido como confiança transitiva onde duas partes, uma transmissora e uma receptora, concordam em confiar nas declarações e atestados de legitimidade uns dos outros emitidos por um provedor de confiança comum e, em seguida, prossigam comunicando o que quiserem, sem qualquer validação adicional onerosa ou outro tipo de verificação.
1.3 Acessando o Diretório
Este guia do usuário assume que as organizações participantes já passaram pelo processo de iniciação com a Estrutura Inicial do Open Insurance Brasil e já concluíram todas as integrações necessárias, processos de assinatura de contrato e inclusão de administrador individual.
1.4 Criação de uma Nova Declaração de Software (SSA)
Uma declaração de software descreve um aplicativo inserido naquilo que pode ser considerado a ‘App Store’ do Open Insurance Brasil. Este registro de aplicativo contém todas as informações necessárias para que uma seguradora identifique tecnicamente e interaja com o aplicativo, além de conter todas as informações que auxiliam os clientes que estejam utilizando-o a confirmar sua legitimidade.
Um novo aplicativo ou declaração de software pode ser registrado fazendo logon no Diretório, acessando sua organização, navegando até ‘Declarações de software’, clicando em ‘Declarações de novo software’ e preenchendo o formulário. Lembre-se de que a maioria dessas informações será exibida aos clientes pelas Seguradoras como parte do processo de redirecionamento ou autorização. Como tal, é importante que todas as URIs e descrições sejam relevantes para o público.
1.4.1 Atribuição de Funções Regulatórias de Software
Em um ecossistema de compartilhamento de dados complexo e diversificado, as funções regulatórias de uma organização podem mudar. Eles podem ser adicionados e revogados. Isso significa que o software adicionado ao Diretório pode receber permissão de ter zero (0) ou mais funções regulatórias. Um administrador pode atribuir a um determinado software todo e qualquer permissões que a organização proprietária do software pode ter.
Se uma organização perder uma função regulatória, todo software com essa função regulatória será revogado do ecossistema, portanto, é muito importante que um aplicativo receba apenas as funções de que realmente precisa para funcionar.
1.5 Criação e Upload de Certificados
1.5.1 Sandbox
O serviço de Diretório do Open Insurance Brasil inclui uma infraestrutura de chave pública que pode ser usada para criar certificados para os aplicativos sendo registrados no ambiente Sandbox. Basta selecionar certificados no menu e seguir as instruções.
O Diretório suporta vários certificados, tipos de chave e um comando e configuração openssl será disponibilizado como um exemplo. Depois de criar a solicitação de assinatura de certificado (Certificate Signing Request - CSR) para um certificado de “Transporte” e “Assinatura”, você pode enviá-los ao diretório para serem validados e transformados em certificados.
Lembre-se de seguir as práticas de gerenciamento de chaves de sua organização para a geração de certificados. Essas credenciais e chaves precisam ser manuseadas com cuidado. Um evento significativo de comprometimento de chave pode levar ao comprometimento dos dados do cliente.
1.5.2 Produção
Os certificados para acesso e assinatura em ambiente de produção devem ser fornecidos pelo ICP Brasil. Os detalhes sobre os certificados e os requisitos para os certificados estão detalhados no Padrão de Certificados Open Insurance Brasil.
1.5.3 O que é um JWT, JWE, JWS e JWK
Quando os certificados são carregados para o Diretório, o framework de confiança os anuncia em JSON Web Key Sets com cada JSON Web Key (JWK) tendo um ‘KID’ ou um Key ID. Os JWKs, além de ter propriedades específicas que descrevem o algoritmo e os conjuntos de criptografia que eles suportam, também anunciam seu “uso”, que pode ser do tipo ‘enc’ para criptografia ou ‘sig’ para assinatura.
Essas chaves ‘sig’ e pares de chaves ‘enc’ são usadas em muitos lugares dentro do ecossistema do Open Insurance Brasil para criptografar ou assinar dados usando os padrões definidos em RFC 7519 JSON Web Token, que deve ser lido em detalhes pelos desenvolvedores.
Esses JWTs podem ser criptografados também usando o JSON Web Encryption (JWE). Na maioria dos casos, as chaves que devem ser usadas para validar uma assinatura da Web JSON (JWS) ou a chave que foi usada para criptografar um JWE são geralmente publicadas como uma JSON Web Key em um JSON Web Key Set com a referência à chave que está sendo carregada no campo de cabeçalho ‘kid’ (Key ID).
O exemplo acima é apresentado decodificado logo abaixo. No cabeçalho está incluso o atributo ‘kid’ (id da chave) com o valor xSkimtEka2S1kt0EAEx2Rf6FKzwGJ-sS4Qxv37lbSiw, que pode ser localizado no JSON Web KeySet para este cliente aqui
Se quiser conhecer um pouco mais e exercitar, visite o site JWT-IO e conheça um pouco mais.
2.0 Interagindo com as APIs de Serviços de Confiança
Quando um aplicativo é registrado no Diretório, o serviço central usa os metadados e certificados fornecidos para criar para o software um cliente OAuth 2.0 que tem um grant type do tipo client credentials, conforme definido em RFC6749 e com um mecanismo de autenticação de cliente definido como tls_client_auth, conforme definido em RFC 8705.
Usando o ClientID listado na declaração do software (software statement) no Diretório, OpenID Connect Discovery e a configuração do OpenID Provider Issuer abaixo, um participante tem todos das informações necessárias para descobrir, autenticar e interagir com as APIs do Diretório
2.1 Emissores do Framework de Confiança do Diretório
Os certificados para acesso às APIs publicadas pelas instituições participantes devem ser obrigatoriamente certificados emitidos no âmbito da ICP-Brasil.
2.2 Como se Comunicar com o Authorization Server do Diretório
Use o OpenID Issuer e a Cláusula 4 da especificação OpenID Connect Discovery para obter o documento openid-configuration.
Estabeleça uma conexão TLS mútua usando o certificado de transporte registrado anteriormente e solicite um token de acesso com o escopo directory:software
As APIs do Diretório são recursos RESTful protegidos usando o Perfil de Segurança do Open Insurance Brasil. Isso significa que eles têm a mesma postura de segurança das APIs publicadas pelas seguradoras. Todas as APIs de Diretório requerem o escopo do recurso OAuth 2.0 de directory:software e são protegidos usando Mutual TLS (mTLS).
Consulte a especificação do Diretório OpenAPI v3 para o conjunto completo de endpoints disponíveis.
2.4 Descobrindo Authorization Servers de Seguradoras
Faça uma busca pelo recurso de participantes (informações públicas) e obtenha uma lista de todos os participantes e seus Authorization Servers.
Filtre os participantes por aqueles que possuem Authorization Servers protegendo os recursos que você está interessado em acessar para o seu produto. No exemplo acima, existem dois Authorization Servers para ‘_’, um para o negócio de varejo e um para o corporativo.
O aplicativo agora descobriu a lista de seguradoras que estão oferecendo APIs que podem ser úteis para os usuários do aplicativo e pode gerar uma lista de ‘customer friendly names’ de seguradoras e logotipos para exibir aos clientes para permitir que eles selecionem a seguradora a partir do qual desejam compartilhar dados.
3.0 Registrando o Aplicativo com um Provedor
A partir do exemplo dado acima, podemos ver que a localização do "OpenIDDiscoveryDocument" é anunciada por cada um dos Authorization Server.
3.1 Criação de uma Declaração de Software (SSA)
Uma afirmação de declaração de software (software statement assertion - SSA) é um JWT assinado pelo Diretório que contém todas as informações sobre um aplicativo que existe em um determinado momento no Diretório. Inclui a localização de todas as chaves públicas vinculadas à esta declaração de software e todos os outros metadados de que uma seguradora precisa para validar a legitimidade do aplicativo.
Um SSA não tem período de validade, é simplesmente um registro pontual do que existia como atributos válidos no momento em que foi criado. As seguradoras devem aceitar um SSA com menos de alguns minutos, mas a janela exata pode ser diferente entre os provedores.
Obtenha um token de acesso e, em seguida, carregue a declaração do software para um aplicativo no Diretório.
Para todas as opções, incluindo todos os códigos de permissão, consulte o Consent API. Os exemplos a seguir são exemplos mínimos, mas funcionais para demonstrar o fluxo de ponta a ponta. Esses exemplos pressupõem que o cliente está se comunicando com um provedor de OpenID, aproveitando o mecanismo de autenticação de endpoint do token tls_client_auth. Exemplos alternativos estão disponíveis no apêndice.
4.1 Pré-requisitos
Esses exemplos não normativos presumem que o cliente OAuth descobriu os locais de todos os 'endpoints' necessários para se comunicar com os recursos das seguradoras do Diretório, incluindo o recurso de consentimento, os recursos de dados e o documento de descoberta de autorização OpenID do Diretório.
Diferentes métodos de autenticação (private_key_jwt e tls_client_auth) e de encaminhamento do Request Object (com e sem uso de PAR) podem ser suportados pelos Authorization Servers de acordo com a especificação FAPI-1.0 Part 2 - Advanced.
Portanto, como reforça o perfil de segurança para o Open Finance Brasil (item 8 da seção 5.2.3 dos requisitos de segurança para o cliente confidencial), todas as 4 combinações de métodos devem ser suportados pelos clientes de API.
Também é opcional para receptoras solicitar claims de identidade ('Identity Claims') adicionais, incluindo CPF e CNPJ. Essas claims são definidas no Perfil de Segurança do Open Insurance Brasil. Também é possível para um receptor solicitar que uma claim corresponda a um determinado valor, baseando-se em OpenID Connect Core Clause 5.5.1 para solicitar claims individuais.
Por exemplo:
"cpf": {
"essential": true,
value: 12345678123
},
Nesse exemplo seria exigido que o provedor OpenID retornasse apenas uma autenticação e autorização bem-sucedidas se o usuário que estava autenticando poderia ser confirmado pela seguradoras que eles tinham um número de CPF de 12345678123. Se a seguradora não puder confirmar este número, então a autenticação deve falhar.
Solicitar reivindicações de valor específico é totalmente opcional para o receptor.
4.3.2 Redirecionar o Usuário ao Authorization Server para Autorização
4.3.4 Verificação do Status do Recurso de Consentimento
Neste ponto, um receptor pode, opcionalmente, verificar o status da solicitação de consentimento para ver se mudou para totalmente autorizado. Esta etapa não deverá ser necessária para recursos que não requerem consentimento de múltiplos indivíduos, entretanto, para contas comerciais ou contas conjuntas com requisitos de acesso especiais, a seguradora pode demorar um pouco para obter as autorizações adicionais necessárias para que esse consentimento seja totalmente autorizado. Os receptores não devem abusar da verificação do status da API de consentimento.
Com o token de acesso que foi retornado em 4.3.3, o receptor agora tem a capacidade de chamar os recursos dos clientes.
Dynamic Client Registration (DCR)
Prefácio
A Estrutura Inicial do Open Insurance Brasil é responsável por criar os padrões e especificações necessários para atender aos requisitos e obrigações da Legislação do Open Insurance do Brasil, conforme originalmente delineado pela SUSEP. É possível que alguns dos elementos deste documento estejam sujeitos a direitos de patente. A Estrutura Inicial não se responsabiliza pela identificação de qualquer ou todos os direitos de patente.
O Perfil de Segurança Financial-grade API 1.0 do Open Insurance Brasil consiste nas seguintes partes:
O Perfil de Registro de Cliente Dinâmico (DCR - Dynamic Client Registration) do Financial-grade API (FAPI) do Open Insurance Brasil é um perfil de RFC7591, RFC7592 e OIDR que visa fornecer diretrizes de implementação específicas para segurança e interoperabilidade que podem ser aplicadas à identificação, registro e gerenciamento de Clients OAuth operando no ecossistema Open Insurance Brasil.
Embora seja possível codificar um OpenID Provider e Relying Party desde o princípio usando esta especificação, o principal público para esta especificação são as partes que já possuem uma implementação certificada do OpenID Connect e desejam obter a certificação para o Open Insurance Brasil.
Convenções Notacionais
As palavras-chave "deve" (shall), "não deve" (shall not), "deveria" (should), "não deveria" (should not) e "pode" (may) presentes nesse documento devem ser interpretadas conforme as diretrizes descritas em ISO Directive Part 2 observando seguinte equivalência:
"deve" => equivalente ao termo "shall" e expressa um requerimento definido no documento (nas traduções é similar ao termo "must", que pode denotar um requerimento externo ao documento);
"não deve" => equivalente ao termo "shall not" e também expressa um requerimento definido no documento;
"deveria" e "não deveria"=> equivalente ao termo "should" e "should not" e expressa uma recomendação
"pode" => equivalente ao termo "may" indica uma permissão
Estas palavras-chave não são usadas como termos de dicionário, de modo que qualquer ocorrência deles deve ser interpretada como palavras-chave e não devem ser interpretados com seus significados de linguagem natural.
Este documento é aplicável a todos os participantes do Open Insurance no Brasil.
2. Referências normativas
Os seguintes documentos referenciados são indispensáveis para a aplicação deste documento. Para referências datadas, apenas a edição citada se aplica. Para referências não datadas, a última edição do documento referenciado (incluindo quaisquer emendas) se aplica.
API – Application Programming Interface (Interface de Programação da Aplicação)
DCR – Dynamic Client Registration (Registro de Cliente Dinâmico)
FAPI - Financial-grade API
HTTP – Hyper Text Transfer Protocol
OIDF - OpenID Foundation
REST – Representational State Transfer
SS – Software Statement (Declaração de Software)
SSA – Software Statement Assertion (Afirmação de Declaração de Software)
TLS – Transport Layer Security
5. Introdução
O ecossistema Open Insurance Brasil apoia-se em um provedor de confiança ou diretório de participantes como a fonte mais valiosa de informações sobre participantes credenciados e softwares que estão autorizados a participar do ecossistema Open Insurance Brasil.
Os serviços do Diretório incluem:
Registro e gerenciamento de software
Registro e gerenciamento de credenciais de software usando certificados ICP
Geração de Software Statement Assertion (SSA)
Os participantes do ecossistema devem aproveitar esses serviços para facilitar o registro de cliente OAuth orientado por API usando o processo descrito na cláusula 3.1.1 do RFC7591 com metadados adicionais necessários para oferecer suporte ao OpenID Connect definido em OpenID Connect Registration.
É importante reforçar que o payload de registro de clientes possui a maior parte de seus atributos não obrigatórios, e que os atributos cujos valores conflitem com os presentes no software statement assertion serão sobrepostos pelos valores do próprio software statement assertion emitido pelo diretório central. Nem todos os metadados que um cliente deseja fornecer podem estar contidos em um software statement, por exemplo, alternativa Metadata Languages and Script values. Há casos ainda de metadados de cliente que são um subconjunto dos valores existentes no SSA, como por exemplo os redirect_URIs.
6. Provisionamentos do OpenID Connect Discovery do Open Insurance Brasil
6.1 Servidor de Autorização
O servidor de autorização deve suportar OpenID Connect Discovery conforme exigido pelo Financial-grade API Security Profile 1.0 - Part 1: Baseline. Este suporte deve estar explicito tanto na forma como o Servidor de Autorização está registrado no Diretório de Participantes quanto na declaração dos seus atributos no arquivo de Discovery (well-known), respeitando os mecanismos de autenticação certificados pela institição através dos testes de conformidade do Open Insurance Brasil.
Adicionalmente, o Servidor de Autorização:
deve anunciar sua presença no ecossistema Open Insurance Brasil, sendo listada no Diretório de Participantes;
deve anunciar todos os recursos API REST do Open Insurance Brasil protegidos pelo Provedor OpenID no Diretório de Participantes;
deve anunciar suporte para todos os mecanismos de assinatura, criptografia, autenticação e padrões necessários para suportar o Open Finance Brasil Financial API;
7. Provisionamento de registro OpenID Connect do Open Insurance Brasil
7.1 Servidor de Autorização
O servidor de autorização deve suportar as RFCs de Dynamic Client Registration (DCR) RFC7591, Dynamic Client Management (DCM) RFC7592 e OpenID Registration
Além disso, o servidor de autorização
deve rejeitar as solicitações de registro de cliente dinâmico não realizadas em uma conexão protegida com mTLS usando certificados emitidos pelo Brasil ICP (produção) ou o Diretório de Participantes (sandbox);
deve validar que a solicitação contém software_statement JWT assinado usando o algoritmo PS256 emitido pelo Diretório de Participantes do Open Insurance Brasil;
deve validar que o software_statement foi emitido (iat - issued at) não mais de 5 minutos antes do pedido ser recebido;
deve validar que um atributo jwks (definida por valor) não foi incluído, e sim declarado como referência no atributo jwks_uri;
deve, quando informado, validar que o jwks_uri corresponda ao software_jwks_uri fornecido na declaração do software;
deve exigir e validar que o redirect_uris corresponda ou contenha um subconjunto dos valores de software_redirect_uris fornecidos no software_statement;
deve exigir e validar que todos os mecanismos de autenticação de cliente cumpram os requisitos definidos nas RFC7591 e RFC7592, através da validação do registration_access_token e, como conexão segura, da cadeia de certificados confiáveis ICP-Brasil.
deve validar se os escopos solicitados são adequados para as permissões regulatórias autorizadas da instituição e contidas no software_statement. A relação de permissões regulatórias e os escopos correspondentes está descrita nas seções a seguir.
deve, sempre que possível, validar os metadados declarados pelo cliente em relação aos metadados fornecidos no software_statement, adotando os valores presentes no SSA com precedência.
se for compatível com o mecanismo de autenticação do cliente tls_client_auth, conforme definido em RFC8705, somente deve aceitar tls_client_auth_subject_dn como uma indicação do valor do atributo subject do certificado, conforme definido na cláusula 2.1.2 RFC8705;
o valor do campo UID do certificado deve coincidir com o enviado no SSA, onde o campo UID deve conter o valor do campo software_id do SSA.
o valor do campo organizationIdentifier do certificado deve conter o prefixo correspondente ao Registration Reference OPIBR- seguido do valor do campo org_id do SSA.
deve, durante o processo de handshake TLS, usar a regra distinguishedNameMatch para comparar os valores DN conforme definido na [RFC4517].
deve garantir a integridade do estoque de consentimentos ativos, mesmo após eventuais mudanças sistêmicas, para que taís alterações sejam transparentes para as instituições receptora de dados.
deve realizar recertificação FAPI e DCR da OIDF após eventuais mudanças sistêmicas.
Quando as propriedades de uma solicitação DCR não estão incluídas e não são obrigatórias na especificação, o Authorization Server deve aplicar os padrões do cliente da seguinte maneira:
deve selecionar e aplicar o algoritmo de criptografia e a escolha da cifra a partir dos conjuntos mais recomendados de cifra da IANA que são suportados pelo Servidor de Autorização;
deve preencher defaults a partir de valores da afirmação de software_statement, sempre que possível;
deve conceder ao cliente permissão para o conjunto completo de escopos potenciais com base nas permissões regulatórias de softwares incluídas no software_statement;
7.1.2 Análise do Distinguished Name do Certificado
A cláusula 3 do Lightweight Directory Access Protocol (LDAP): String Representation of Distinguished Names define os OIDs obrigatórios cujas as strings do AttributeType (descritores) devem ser reconhecidos pelos implementadores. Esta lista obrigatória não inclui vários dos OIDs definidos em Open Insurance Brasil x.509 Certificate Standards, nem existe um mecanismo definido para os Servidores de Autorização publicarem informações sobre o formato que eles esperam de uma Solicitação Dinâmica de Registro do Cliente (Dynamic Client Registrarion) que inclui um tls_client_auth_subject_dn.
Para resolver essa ambiguidade, o Servidor de Autorização deve aceitar exclusivamente os AttributeType (descritores) definidas no último parágrafo da cláusula 3 RFC4514 em formato string, também deve aceitar em formato OID, com seus valores em ASN.1, todos os AttributeTypes definidos no Distinguished Name Open Insurance Brasil x.509 Certificate Standards ou adicionados pela Autoridade Certificadora.
Em caso de não atendimento destes requisitos o Servidor de Autorização deverá rejeitar o registro.
Segue na tabela abaixo como deve ser feita a decodificação:
Obtenha na ordem reversa os atributos do certificado
Concatene cada RDN (RelativeDistinguishedName) com uma virgula (',')
Use as strings da RFC (CN, L, ST, O, OU, C, Street, DC, UID) com o valor dos seus atributos legível para humanos
Use os OIDs dos atributos definidos nesta especificação para uso no OFB (businessCategory = OID 2.5.4.15, jurisdictionCountryName = OID 1.3.6.1.4.1.311.60.2.1.3, serialNumber = OID 2.5.4.5) com o valor dos seus atributos em formato ASN.1 seguindo a RFC4514, sendo que:
Os nomes dos atributos devem ser definidos seguindo a notação ponto-decimal, sem adição de prefixo “OID”, ex. “2.5.4.15”, seguido dos sinais de (‘=#’) mais o valor hexadecimal do atributo, exemplo final: 2.5.4.15=#0C1450726976617465204F7267616E697A6174696F6E
Não há qualquer restrição para as codificações/formatações utilizadas nos valores dos atributos. Deve ser respeitado o uso em hexadecimal apresentado na codificação utilizada no atributo do certificado (PrintableString, UTF8String, etc). Este item atende à opcionalidade do formato já estabelecido pela AC frente aos normativos ICP e ao itens 2.3, 2.4 e 5.2 da RFC4514.
Seguem abaixo exemplos para os atributos obrigatórios da CAs atualmente ativas:
7.2 Funções regulatórias para mapeamentos OpenID e OAuth 2.0
Para participar do ecossistema do Open Insurance, as instituições credenciadas devem se cadastrar no Diretório de Participantes de acordo com seus papéis regulatórios. Essas funções refletem a autorização do SUSEP para as instituições e, consequentemente, as APIs que podem utilizar.
A tabela a seguir descreve as funções regulatórias do Open Insurance e o mapeamento de escopos do OAuth 2.0 relacionado. Se os escopos forem omitidos durante o processo de DCR, o Servidor de Autorização deve conceder o conjunto completo de escopos potenciais com base nas funções regulatórias registradas para a seguradora, conforme descrito na seção Server Defaults.
É necessário validar as roles ativas no software_statement da aplicação. Na validação dessa informação deve ser utilizado o campo software_statement_roles, e deve ser verificado se as roles listadas estão ativas.
7.3 Registro do Cliente
No processo de registro do cliente, utilizando-se o método de autenticação tls_client_auth, o cliente deve encaminhar o campo tls_client_auth_subject_dn com os AttibuteTypes(Descritores) em formato definido no item 7.1.2 Análise do Distinguished Name do Certificado. Em caso de não aderencia a este padrão o registro será rejeitado.
8. Declaração de Software
Uma declaração de software (software_statement) é um JSON Web Token (JWT) que afirma valores de metadados sobre o software cliente como um todo. Na estrutura do Open Insurance Brasil, esse software_statement é assinado pelo Diretório de Participantes, e sua assinatura DEVE ser validada pelos Servidores de Autorizacao usando as chaves públicas disponíveis na seção a seguir.
8.1 Atributos da Declaração de Software (Claims)
O exemplo a seguir contém todos os atributos atualmente incluídos em um software_statement:
9. Processamento de solicitação de registro de cliente dinâmico
9.1 Enviar uma solicitação com uma declaração de software
Este exemplo inclui vários campos opcionais, alguns dos quais podem não ser aplicáveis a algumas implantações. Para um guia completo dos atributos e sua obrigatoriedade, consultar o Swagger DCR.
A quebra de linha dentro dos valores são apenas para fins de exibição.
9.2 Open Insurance Brasil SSA Key Store e detalhes do emissor
As links a seguir apontam para as chaves públicas do Diretório de Participantes, e devem ser usadas para verificar a validadade da assinatura dos software_statements apresentados durante o processo de registro de cliente.
Emissor do Open Insurance Open Insurance Brasil SSA de sandbox
9.3 Sobre os mecanismos de autenticação e autorização dos serviços de DCR e DCM
Por serem serviços auxiliares ao fluxo principal do Open Insurance Brasil, os serviços de registro e manutenção dinâmica de clientes não utilizam os mesmos mecanismos de controle de acesso. Por exemplo: não é possível exigir um access_token OAuth 2.0 de uma aplicação cliente que ainda não está registrada na instituição transmissora.
Para estender as RFC7591 e RFC7592, que recomendam mecanismos mínimos para autenticação dos seus serviços, as instituições que suportam os fluxos de registro e manutenção dinâmica de clientes devem implementar em seus Servidores de Autorização os controles a seguir:
9.3.1 Registro de cliente - POST /register
validar que o certificado apresentado pela aplicação cliente é subordinado às cadeias do ICP-Brasil definidas no Padrão de Certificados do Open Insurance Brasil;
assegurar que a assinatura do software_statement apresentado pela aplicação cliente durante o registro tenha sido feita pelo Diretório de Participantes através das chaves públicas descritas na seção anterior;
assegurar que o software_statement apresentado pela aplicação cliente durante o registro corresponda à mesma instituição do certificado de cliente apresentado, validando-o através dos atributos que trazem organization_id no certificado X.509.
emitir, na resposta do registro, um registration_access_token para ser usado como token de autenticação nas operações de manutenção da aplicação cliente registrada, seguindo as especificações descritas na RFC7592.
não devem ser permitidos múltiplos cadastros DCR para o mesmo Software Statement, de forma que em caso de tentativa de novo registro para um Software Statement já cadastrado, deve se utilizar o procedimento de Error Response definido no item 3.2.2 da RFC7591.
9.3.2 Manutenção de cliente - GET /register - PUT /register - DELETE /register
validar que o certificado apresentado pela aplicação cliente é subordinado às cadeias do ICP-Brasil definidas no Padrão de Certificados do Open Insurance Brasil;
validar a presença e a correspondência do header Bearer Authorization contendo o valor do atributo registration_access_token retornado durante o registro do cliente correspondente.
Observação: A RFC7592 prevê a possibilidade de rotação do registration_access_token emitido pelo Servidor de Autorização a cada uso, tornando-o um token de uso único. As instituições devem considerar esse aspecto no registro de suas aplicações cliente para receber e atualizar o registration_access_token pelo novo valor recebido nas chamadas de manutenção de cliente.
A Estrutura Inicial do Open Insurance Brasil é responsável por criar os padrões e especificações necessários para atender aos requisitos e obrigações da Legislação do Open Insurance do Brasil, conforme originalmente delineado pela SUSEP. É possível que alguns dos elementos deste documento estejam sujeitos a direitos de patente. A Estrutura Inicial não se responsabiliza pela identificação de qualquer ou todos os direitos de patente.
Objetivo
Especificar o conjunto de certificados necessários que devem ser utilizados pelas entidades participantes do Open Insurance Brasil para garantir interoperabilidade para autenticação, confidencialidade, integridade e não repúdio entre os participantes, bem como para os usuários e consumidores destas entidades. O público desta especificação são entidades participantes do Open Insurance Brasil que necessitam fazer a emissão de certificados para se autenticar junto a outras entidades, bem como oferecer a seus clientes um canal de autenticação seguro.
Convenções Notacionais
As palavras-chave "deve" (shall), "não deve" (shall not), "deveria" (should), "não deveria" (should not) e "pode" (may) presentes nesse documento devem ser interpretadas conforme as diretrizes descritas em ISO Directive Part 2 observando a seguinte equivalência:
"deve" => equivalente ao termo "shall" e expressa um requerimento definido no documento (nas traduções é similar ao termo "must", que pode denotar um requerimento externo ao documento);
"não deve" => equivalente ao termo "shall not" e também expressa um requerimento definido no documento;
"deveria" e "não deveria"=> equivalente ao termo "should" e "should not" e expressa uma recomendação
"pode" => equivalente ao termo "may" indica uma permissão
Estas palavras-chave não são usadas como termos de dicionário, de modo que qualquer ocorrência deles deve ser interpretada como palavras-chave e não devem ser interpretados com seus significados de linguagem natural.
1. Escopo
Este documento especifica os tipos de certificados necessários para:
Autenticar mutuamente (MTLS - Mutual TLS) as aplicações dos participantes;
Assinatura de Mensagens (JWS - JSON Web Signature) de aplicações para garantir a autenticidade e não repúdio de mensagens entre os participantes;
Apresentar um canal seguro e confiável para clientes do Open Insurance Brasil;
Autenticar participantes no Diretório de participantes do Open Insurance Brasil.
2. Referências Normativas
Os seguintes documentos referenciados são indispensáveis para a aplicação deste documento. Para referências datadas, apenas a edição citada se aplica. Para referências não datadas, a última edição do documento referenciado (incluindo quaisquer emendas) se aplica.
Para o propósito deste documento os termos definidos na RFC5280, BCP195, RFC8705, e ISO29100 são aplicáveis.
4. Glossário
API – Application Programming Interface
DCR – Dynamic Client Registration
HTTP – Hyper Text Transfer Protocol
ICP - Infraestrutura de Chave Públicas Brasileira
SS – Software Statement
SSA – Software Statement Assertion
TLS – Transport Layer Security
mTLS – Mutual Transport Layer Security
5. Padrão de Certificados Open Insurance Brasil
5.1 Introdução
O ecossistema do Open Insurance Brasil faz uso de cadeias de certificados e protocolo TLS para garantir a confidencialidade, autenticação e integridade do canal de comunicação utilizado pelas APIs das instituições participantes, bem como dos clientes de cada um dos participantes.
Os certificados utilizados pelo Open Insurance Brasil também são necessários para autenticar as aplicações através do oAuth 2.0 mTLS ou private_key_jwt, além de também servirem para realizar a assinatura de payloads pelo uso de JWS. Outra atribuição importante dos certificados é autenticar e apresentar um canal seguro para o usuário final no ato de autenticação e uso dos serviços prestados pela entidade participante.
5.2 Certificados ICP-Brasil
Os certificados emitidos pelas Autoridades Certificadoras autorizadas pelo ICP-Brasil são utilizados apenas na comunicação entre as entidades participantes do ecossistema do Open Insurance Brasil.
Os processos de emissão e revogação dos certificados são de responsabilidade das próprias Autoridades Certificadores, sendo regulamentados por Declarações de Prática de Certificação, e supervisionadas pelo Comitê Gestor da Infraestrutura de Chaves Públicas Brasileira.
As práticas, processos, disponibilização e valores praticados pelas Autoridades Certificadoras não são de responsabilidade do Estrutura Inicial do Open Insurance Brasil.
Algoritmos
Todos os certificados emitidos junto ao ICP-Brasil devem possuir as seguintes características:
Tipo A do ICP-Brasil;
Algoritmo de Chaves: RSA 2048 bits;
Message Digest: SHA 256 bits.
5.2.1 Certificado Servidor
O Certificado Servidor deve ser emitido para proteger e autenticar o canal TLS utilizado pelas APIs que serão consumidas pelas aplicações cliente de entidades participantes do Open Insurance.
O padrão de certificado utilizado deve seguir as práticas de emissão de certificados existentes de "CERTIFICADO PARA SERVIDOR WEB – ICP-Brasil".
O certificado de servidor precisa ser enviado com a cadeia intermediária, conforme RFC5246 (itens 7.4.2).
5.2.2 Certificado Cliente
Os Certificados de Aplicação Cliente (Transporte) são utilizados para autenticar o canal mTLS e para realizar a autenticação da aplicação cliente através de oAuth2.0 mTLS ou private_key_jwt, de acordo com o cadastro da aplicação realizado pelo processo de Dynamic Client Registration junto à entidade transmissora. Sobre o mTLS, o certificado cliente precisa ser enviado com a cadeia intermediária, conforme RFC5246 (itens 7.4.2 e 7.4.6).
Para emissão de Certificado Cliente é necessário que a instituição participante do Open Insurance Brasil tenha realizado o cadastro da aplicação no Serviço de Diretório, através do processo de emissão de Software Statement Assertion, e com isso já tenha obtido o valor de Software Statement ID.
5.2.2.1 Atributos Open Insurance Brasil
serialNumber: Cadastro Nacional de Pessoal Jurídica (CNPJ) da pessoa jurídica titular do certificado e associado ao atributo UID e Software Statement ID, durante validação junto ao Serviço de Diretório do Open Insurance Brasil;
organizationIdentifier: Código de Participante associado ao CNPJ listado no Serviço de Diretório do Open Insurance Brasil;
UID: Software Statement ID cadastrado no Serviço de Diretório do Open Insurance Brasil e pertencente ao CNPJ e Código de Participante.
O Certificado Cliente deve ser emitido através de cadeia V10, e deve obrigatoriamente conter os seguintes atributos:
Distinguished Name
businessCategory (OID 2.5.4.15): Tipo de categoria comercial, devendo conter: "Private Organization" ou "Government Entity" ou "Business Entity" ou "Non-Commercial Entity"
stateOrProvinceName (OID 2.5.4.8): Unidade da federação do endereço físico do titular do certificado
localityName (OID 2.5.4.7): Cidade do endereço físico do titular
organizationIdentifier (OID 2.5.4.97): Código de Participante associado ao CNPJ listado no Serviço de Diretório do Open Insurance Brasil e prefixo de identificação do diretório
UID (OID 0.9.2342.19200300.100.1.1): Software Statement ID gerado pelo Diretório do Open Insurance Brasil
otherName (OID 2.16.76.1.3.2 – ICP-Brasil): Nome do responsável pelo certificado
otherName (OID 2.16.76.1.3.3 – ICP-Brasil): Cadastro Nacional de Pessoa Jurídica (CNPJ) da pessoa jurídica titular do certificado;
otherName (OID 2.16.76.1.3.4 – ICP-Brasil): Responsável pelo certificado de pessoa jurídica titular do certificado (data de nascimento, CPF, PIS/PASEP/CI, RG);
otherName (OID 2.16.76.1.3.7 – ICP-Brasil): Número do Cadastro Especifico do INSS (CEI) da pessoa jurídica titular do certificado.
5.2.3.2 Autoridades Certificadoras Participantes
As seguintes autoridades certificadoras realizaram o processo de onboarding ao Open Insurance Brasil e estão habilitadas para realizar a emissão de certificados do Open Insurance Brasil utilizando para tal os certificados nível 1 aqui listados:
Os certificados para Front-End são utilizados para disponibilizar serviços, em geral páginas Web, com uso de TLS, que são acessados pelo usuário final. Dado a sua finalidade, e para garantir maior interoperabilidade, os certificados devem ser do tipo EV (Extended Validation) e devem ser ser gerados através de uma autoridade certificadora válida, seguindo as regras definidas na RFC 5280 e RFC 2818, em conformidade com os princípios e critérios WebTrust.
Apêndice
Modelo de Configuração de Certificado Cliente - OpenSSL
Tabela com Endpoints vs Tipo de Certificado e mTLS
Abaixo apresentamos quais endpoints podem ser publicados utilizando certificado EV como autenticação do consentimento e os endpoints de autenticação de APIs privadas/negócios que devem ser publicadas usando certificado ICP. Você também poderá verificar quais endpoints devem proteger suas conexões utilizando mTLS.
Fica a critério da instituição a escolha do certificado que deve ser adotado para os endpoints da Fase 1, os quais, por natureza, são de acesso público.
Uma interface de programação de aplicativo é um conjunto de rotinas, protocolos e ferramentas para construir aplicativos de software. Uma API especifica como os componentes de software devem interagir
FAPI
Financial API
Especificação técnica de API e define requisitos técnicos adicionais para o setor financeiro
CIBA
Client Initiated Backchannel Authentication
A autenticação de backchannel iniciada pelo cliente (CIBA) é um dos padrões mais recentes da OpenID Foundation. São categorizados como "fluxo desacoplado". Permite novas maneiras de obter o consentimento do usuário final
OAuth
O OAuth é um protocolo de autorização para APIs web voltado a permitir que aplicações client acessem um recurso protegido em nome de um usuário
OIDC
OpenID Connect
OpenID Connect é um protocolo de identidade simples com padrão aberto
JWT
JSON Web Token
Uma técnica definida na RFC 7519 para autenticação remota entre duas partes. Ele é uma das formas mais utilizadas para autenticar usuários em APIs RESTful
JWS
JSON Web Signature
Uma forma de garantir a integridade das informações em um formato altamente serializado
SHA256
Secure Hash Algorithm
Um conjunto de funções criptográficas de hash
PKCE
Proof Key for Code Exchange
Chave de prova para troca de código por clientes públicos Oauth
MAC
Código de Autenticação de Mensagem
Permite que as declarações sejam assinadas digitalmente ou protegidas por integridade utilizando JWS
ICP-Brasil
Infraestrutura de Chaves Públicas Brasileira
Na definição oficial, “uma cadeia hierárquica de confiança que viabiliza a emissão de certificados digitais para identificação virtual do cidadão"
AC
Autoridade Certificadora
AR
Autoridade de Registro
TLS
Transport Layer Security
ECDSA
Elliptic Curve Digital Signature Algorithm
Algoritmo de método de assinatura digital de documentos utilizando criptografia baseada em curvas elípticas
ECDHE
Elliptic-curve Diffie–Hellman
Protocolo de contrato chave que permite que duas partes, cada uma com um par de chaves público-privado de curva elíptica, estabeleçam um segredo compartilhado em um canal inseguro
AES
Advanced Encryption Standard
Algoritmos de criptografia de bloco simétrico com uma chave de criptografia de 256 bits
Autenticação mútua
Chamamos de autenticação mútua quando ambos cliente e servidor apresentam certificados para serem validados pelo par
CSR
Certificate Signing Request
Contém informação que irá ser incluída no seu certificado como o nome da empresa/organização, common name (domínio), localidade e país. Também contém a chave pública (public key) que será incluída no seu certificado. Normalmente é também criada uma chave privada (private key) ao mesmo tempo que é criado o CSR
SSA
Software Statement Assertion
SSA é um JSON Web Token (JWT) que contém metadados sobre uma instância de aplicativo client desenvolvida por um TPP. O JWT é emitido e assinado pelo Diretório do Open Insurance Brasil
End User
Identificação de usuário final que possui as informações que se deseja acessar
Back-End
Aplicação ou código que da inteligência de negocio as ações solicitadas via API , código que efetivamente realiza a função desejada
Json
JavaScript Object Notation
Modelo para armazenamento e transmissão de informações no formato texto.
Claims
Escopos/declarações usadas em uma API durante a autenticação para autorizar o acesso aos detalhes de um usuário, como nome e imagem por exemplo. Cada escopo retorna um conjunto de atributos do usuário, que são chamados de declarações
Header
Cabeçalho de uma solicitação ou resposta que transmite contexto e metadados adicionais sobre a solicitação ou resposta. Por exemplo, em uma mensagem de solicitação podem ser usados para fornecer credenciais de autenticação
Payload
Carga Útil do token JWT. É aqui que você coloca informações como a quem o token pertence, qual a expiração dele, quando ele foi criado, entre outras coisas
A especificação do arquivo de participantes pode ser acessada aqui.
Organisations
Recupera informações técnicas sobre Participantes registrados no diretório, essas informações permitem identificar e consumir as APIs dos participantes
REQUIRED. URL of the OP's OAuth 2.0 Authorization Endpoint
claims_parameter_supported
boolean
false
none
OPTIONAL. Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. If omitted, the default value is false
claims_supported
[any]
false
none
RECOMMENDED. JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for
code_challenge_methods_supported
[any]
false
none
none
end_session_endpoint
string
false
none
none
check_session_endpoint
string
false
none
none
grant_types_supported
[any]
false
none
OPTIONAL. JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports
id_token_signing_alg_values_supported
[any]
false
none
REQUIRED. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT
issuer
string
false
none
REQUIRED. URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier
jwks_uri
string
false
none
REQUIRED. URL of the OP's JSON Web Key Set [JWK] document.
registration_endpoint
string
false
none
RECOMMENDED. URL of the OP's Dynamic Client Registration Endpoint
request_object_signing_alg_values_supported
string
false
none
OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects
request_parameter_supported
boolean
false
none
OPTIONAL. Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. If omitted, the default value is false
request_uri_parameter_supported
boolean
false
none
OPTIONAL. Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. If omitted, the default value is true
require_request_uri_registration
boolean
false
none
OPTIONAL. Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter
pushed_authorization_request_endpoint
[any]
false
none
none
response_modes_supported
[any]
false
none
OPTIONAL. JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports
response_types_supported
[any]
false
none
REQUIRED. JSON array containing a list of the OAuth 2.0 response_type values that this OP supports
scopes_supported
[any]
false
none
RECOMMENDED. JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports
subject_types_supported
[any]
false
none
REQUIRED. JSON array containing a list of the Subject Identifier types that this OP supports
token_endpoint_auth_methods_supported
[any]
false
none
OPTIONAL. JSON array containing a list of Client Authentication methods supported by this Token Endpoint
token_endpoint_auth_signing_alg_values_supported
[any]
false
none
OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint for the signature on the JWT
token_endpoint
string
false
none
URL of the OP's OAuth 2.0 Token Endpoint
userinfo_endpoint
string
false
none
RECOMMENDED. URL of the OP's UserInfo Endpoint
userinfo_signing_alg_values_supported
[any]
false
none
OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT
O Service Desk do Open Insurance Brasil pode ser acessado tanto via interface gráfica quanto por meio sistêmico através de APIs.
Para acessar a documentação das APIs do Service Desk é necessário logar na ferramenta via interface gráfica, acessar a sessão de FAQ e selecionar o menu "API SysAid".
As funcionalidades previamente liberadas para acesso são:
(Status) Encaminhado N2 atendimento
(Status) Em Análise N2
(Status) Em Atendimento N2
(Status) Encaminhado N1 Encerramento
Interação com chamado através da API do SysAid
Como documento adicional, é possível fazer o download de um PDF nesse link
(Especificação APIs Service Desk) contendo todas as informações listadas no repositório acima.
Monitoramento
As APIs de Status, de Outages e Métricas são comuns a todos os participantes do Open Insurance Brasil, independentemente da fase de adesão. Portanto, todas as instituições devem publicar essas APIs que monitoram a situação do ambiente. Reforçamos ainda que na API de métricas devem ser reportados os dados de performance de todas demais APIs que a instituição desenvolveu.
APIs - Comuns
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
As APIs descritas neste documento são referentes as APIs da fase Open Data do Open Insurance Brasil.
Descrição referente ao código de status retornado pelas APIs
Parameters
Name
In
Type
Required
Description
page
query
integer
false
Número da página que está sendo requisitada, sendo a primeira página 1.
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"status":[{"code":"OK","explanation":"Retorno com Sucesso","detectionTime":"2021-07-21T08:30:00Z","expectedResolutionTime":"2021-07-21T08:30:00Z","updateTime":"2021-01-02T01:00:00Z","unavailableEndpoints":["https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"]}]},"links":{"self":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>","first":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>","prev":"string","next":"string","last":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"},"meta":{"totalRecords":9,"totalPages":3}}
a descrição referente a listagem de indisponibilidades agendadas para os serviços
Parameters
Name
In
Type
Required
Description
page
query
integer
false
Número da página que está sendo requisitada, sendo a primeira página 1.
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":[{"outageTime":"2020-07-21T08:30:00Z","duration":"PT2H30M","isPartial":false,"explanation":"Atualização do API Gateway","unavailableEndpoints":["https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"]}],"links":{"self":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>","first":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>","prev":"string","next":"string","last":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"},"meta":{"totalRecords":9,"totalPages":3}}
{"data":{"status":[{"code":"OK","explanation":"Retorno com Sucesso","detectionTime":"2021-07-21T08:30:00Z","expectedResolutionTime":"2021-07-21T08:30:00Z","updateTime":"2021-01-02T01:00:00Z","unavailableEndpoints":["https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"]}]},"links":{"self":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>","first":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>","prev":"string","next":"string","last":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"},"meta":{"totalRecords":9,"totalPages":3}}
{"data":[{"outageTime":"2020-07-21T08:30:00Z","duration":"PT2H30M","isPartial":false,"explanation":"Atualização do API Gateway","unavailableEndpoints":["https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"]}],"links":{"self":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>","first":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>","prev":"string","next":"string","last":"https://api.seguradora.com.br/open-insurance/channels/v1/<resource>"},"meta":{"totalRecords":9,"totalPages":3}}
Properties
Name
Type
Required
Restrictions
Description
data
[any]
true
none
none
» outageTime
string
true
none
Data e hora planejada do início da indisponibilidade
» duration
string
true
none
Duração prevista da indisponibilidade
» isPartial
boolean
true
none
Flag que indica se a indisponibilidade é parcial (atingindo apenas alguns end points) ou total (atingindo todos os end points)
{"code":"OK","explanation":"Retorno com Sucesso","detectionTime":"2021-07-21T08:30:00Z","expectedResolutionTime":"2021-07-21T08:30:00Z","updateTime":"2021-01-02T01:00:00Z","unavailableEndpoints":["https://api.seguradora.com.br/open-insurance/channels/v1/electronic-channels"]}
Properties
Name
Type
Required
Restrictions
Description
code
string
true
none
Condição atual da API: * OK - A implementação é totalmente funcional * PARTIAL_FAILURE - Um ou mais endpoints estão indisponíveis * UNAVAILABLE - A implementação completa está indisponível * SCHEDULED_OUTAGE - Uma interrupção anunciada está em vigor
explanation
string
true
none
Fornece uma explicação da interrupção atual que pode ser exibida para um cliente final. Será obrigatoriamente preenchido se code tiver algum valor que não seja OK
detectionTime
string
false
none
A data e hora em que a interrupção atual foi detectada. Será obrigatoriamente preenchido se a propriedade code for PARTIAL_FAILURE ou UNAVAILABLE
expectedResolutionTime
string
false
none
A data e hora em que o serviço completo deve continuar (se conhecido). Será obrigatoriamente preenchido se code tiver algum valor que não seja OK
updateTime
string
false
none
A data e hora em que esse status foi atualizado pela última vez pelo titular dos dados.
unavailableEndpoints
[string]
false
none
Endpoints com indisponibilidade
Enumerated Values
Property
Value
code
OK
code
PARTIAL_FAILURE
code
UNAVAILABLE
code
SCHEDULED_OUTAGE
API - Admin
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
As APIs administrativas são recursos que podem ser consumidos apenas pelo diretório para avaliação e controle da qualidade dos serviços fornecidos pelas instituições
Número de chamadas não autenticadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
highPriority
object
true
none
Número de chamadas para o nível de alta prioridade.
» currentDay
integer
true
none
Número de chamadas no dia atual para o nível de alta prioridade.
» previousDays
[integer]
true
none
Número de chamadas nos dias anteriores para o nível de alta prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
mediumPriority
object
true
none
Número de chamadas para o nível de média prioridade.
» currentDay
integer
true
none
Número de chamadas no dia atual para o nível de média prioridade.
» previousDays
[integer]
true
none
Número de chamadas nos dias anteriores para o nível de média prioridade. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
unattended
object
true
none
Número de chamadas para o nível não acompanhado.
» currentDay
integer
true
none
Número de chamadas no dia atual para o nível não acompanhado.
» previousDays
[integer]
true
none
Número de chamadas nos dias anteriores para o nível não acompanhado. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
Tempo médio de resposta para chamadas não autenticadas.
» currentDay
integer
true
none
Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays
[integer]
true
none
Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
highPriority
object
true
none
Tempo médio de resposta de chamadas para o nível de alta prioridade.
» currentDay
integer
true
none
Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays
[integer]
true
none
Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
mediumPriority
object
true
none
Tempo médio de resposta para chamadas para o nível de média prioridade.
» currentDay
integer
true
none
Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays
[integer]
true
none
Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
unattended
object
true
none
Tempo médio de resposta para chamadas para o nível não acompanhado.
» currentDay
integer
true
none
Tempo médio de resposta em milissegundos para chamadas no dia atual.
» previousDays
[integer]
true
none
Tempo médio de resposta em milissegundos para chamadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
AverageTPSMetrics
{"currentDay":0,"previousDays":[0]}
Properties
Name
Type
Required
Restrictions
Description
currentDay
integer
true
none
Número médio de chamadas por segundo no dia.
previousDays
[integer]
true
none
Número médio de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
PeakTPSMetrics
{"currentDay":0,"previousDays":[0]}
Properties
Name
Type
Required
Restrictions
Description
currentDay
integer
true
none
Pico de chamadas por segundo no dia.
previousDays
[integer]
true
none
Pico de chamadas por segundo nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
ErrorMetrics
{"currentDay":0,"previousDays":[0]}
Properties
Name
Type
Required
Restrictions
Description
currentDay
integer
true
none
Número de chamadas com erro no dia atual.
previousDays
[integer]
true
none
Número de chamadas com erro nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
RejectionMetrics
{"currentDay":0,"previousDays":[0]}
Properties
Name
Type
Required
Restrictions
Description
currentDay
integer
true
none
Número de chamadas rejeitadas no dia atual.
previousDays
[integer]
true
none
Número de chamadas rejeitadas nos dias anteriores. O primeiro item do array é referente a ontem, e assim por diante. Devem ser retornados no máximo sete dias caso estejam disponíveis.
Estas APIs disponíveis visam exibir e compartilhar dados não sensíveis de instituições participantes do OpenInsurance Brasil, disponibilizando ao público informações sobre os seus canais de atendimento e as características de produtos e serviços tradicionais de seguro que oferecem.
API - Canais de Atendimento
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
As APIs descritas neste documento são referentes as APIs da fase Open Data do Open Insurance Brasil.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Intermediarios. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
GET /referenced-network/{countrySubDivision}/{serviceType}
Obtem a lista dos produtos do tipo Rede Referenciada
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
countrySubDivision
path
string
true
Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado
serviceType
path
string
true
Listagem de tipos que deve ser padronizada na proposta técnica submetida pela Estrutura Inicial de Governança para observância comum por todas as sociedades participantes
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","identification":[{"name":"Empresa B","cnpjNumber":12341234123412,"products":[{"code":"01234589-0","name":"Produto de Seguro","coverage":["string"]}],"postalAddress":[{"address":"'Rua Diamantina, 59, bloco 35' Praça da Boa Vontade, s/n","additionalInfo":"Loja B","districtName":"Paraíso","townName":"São Paulo","ibgeCode":"string","countrySubDivision":"AC","postCode":1310200,"country":"ANDORRA","countryCode":"BRA","geographicCoordinates":{"latitude":-89.836518,"longitude":-179.836519}}],"access":[{"standards":[{}],"restrictionIndicator":false,"phones":[{}]}],"services":[{"type":"ASSISTENCIA_AUTO","typeOthers":"string","name":["ACIONAMENTO_E_OU_AGENDAMENTO_DE_LEVA_E_TRAZ"],"description":"string"}]}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/channels/v1","first":"https://api.organizacao.com.br/open-insurance/channels/v1","prev":"https://api.organizacao.com.br/open-insurance/channels/v1","next":"https://api.organizacao.com.br/open-insurance/channels/v1","last":"https://api.organizacao.com.br/open-insurance/channels/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Rede Referenciada. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
Número completo do CNPJ da instituição responsável pela dependência - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. Deve-se ter apenas os números do CNPJ, sem máscara
{"name":"Marca A","companies":[{"name":"Empresa da Marca A","cnpjNumber":"string","electronicChannels":[{"identification":{"type":"CHAT","accessType":"EMAIL","urls":["string"]},"services":[{"name":"ABERTURA_CONTAS_DEPOSITOS_OU_PAGAMENTO_PRE_PAGA","code":"RECLAMACAO"}],"availability":{"standards":[{"weekday":"SEGUNDA_FEIRA","openingTime":"10:00:57Z","closingTime":"16:00:57Z"}]}}]}]}
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da marca selecionada pela Organização proprietária da dependência (titular).
{"name":"Empresa da Marca A","cnpjNumber":"string","electronicChannels":[{"identification":{"type":"CHAT","accessType":"EMAIL","urls":["string"]},"services":[{"name":"ABERTURA_CONTAS_DEPOSITOS_OU_PAGAMENTO_PRE_PAGA","code":"RECLAMACAO"}],"availability":{"standards":[{"weekday":"SEGUNDA_FEIRA","openingTime":"10:00:57Z","closingTime":"16:00:57Z"}]}}]}
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da marca selecionada pela Organização proprietária da dependência (titular).
cnpjNumber
string
true
none
CNPJ da sociedade responsável pelo canal de atendimento - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica.
Deverá trazer toda a informação referente ao endereço da dependência informada. Tipo de logradouro + Nome do logradouro + Número do Logradouro (se não existir usar ' s/n') + complemento (se houver).
additionalInfo
string
false
none
Alguns logradouros ainda necessitam ser especificados por meio de complemento, conforme o exemplo a seguir.
districtName
string
true
none
Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas.
townName
string
true
none
O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado.
ibgeCode
string
true
none
Código IBGE de Município. A Tabela de Códigos de Municípios do IBGE apresenta a lista dos municípios brasileiros associados a um código composto de 7 dígitos, sendo os dois primeiros referentes ao código da Unidade da Federação.
countrySubDivision
string
true
none
Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. São consideradas apenas as siglas para os estados brasileiros.
postCode
string
true
none
Código de Endereçamento Postal. Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios.
country
string
false
none
Nome do país.
countryCode
string
false
none
Código do país de acordo com o código “alpha3” do ISO-3166.
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","identification":[{"name":"Intermediário C","nameOther":"Intermediário D","documentNumber":12341234123412,"type":"CORRETOR_DE_SEGUROS","SUSEP":15414622222222222,"postalAddress":[{"address":"'Rua Diamantina, 59, bloco 35' Praça da Boa Vontade, s/n","additionalInfo":"Loja B","districtName":"Paraíso","townName":"São Paulo","ibgeCode":"string","countrySubDivision":"AC","postCode":1310200,"country":"ANDORRA","countryCode":"BRA","geographicCoordinates":{"latitude":-89.836518,"longitude":-179.836519}}],"access":{"standards":[{"openingTime":"10:00:57Z","closingTime":"16:00:57Z","weekday":"DOMINGO"}],"email":"Joao.silva@seguradoraa.com.br","site":"https://openinsurance.com.br/aaa","phones":[{"type":"FIXO","countryCallingCode":55,"areaCode":11,"number":30041000}]},"services":[{"name":"ACONSELHAMENTO_SOBRE_PRODUTOS_OFERTADOS","nameOthers":"string","line":["CAPITALIZACAO"]}]}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes
Deverá trazer toda a informação referente ao endereço do intermediário: Tipo de logradouro + Nome do logradouro + Número do Logradouro (se não existir usar ' s/n') + complemento (se houver)
additionalInfo
string
false
none
Alguns logradouros ainda necessitam ser especificados por meio de complemento, conforme o exemplo a seguir: 'Loja B', 'Fundos', 'Casa 2', 'Lote C'
districtName
string
false
none
Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas
townName
string
true
none
Localidade: O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado
ibgeCode
string
true
none
7 dígitos (o último é um código verificador).
countrySubDivision
string
true
none
Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. p.ex. 'AC'. São consideradas apenas as siglas para os estados brasileiros:
postCode
string
true
none
Código de Endereçamento Postal: Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios
country
string
false
none
Lista de países vide aba 'Lista de países'
countryCode
string
false
none
Código do país de acordo com o código “alpha3” do ISO-3166. p.ex.'BRA'
{"name":"Marca A","companies":[{"name":"Empresa da Marca A","cnpjNumber":"45086338000178","phoneChannels":[{"identification":{"type":"OUVIDORIA","phones":[{"countryCallingCode":"55","areaCode":"19","number":"08007787788"}]},"services":[{"name":"AVISO_SINISTRO","code":"01"}],"availability":{"standards":[{"weekday":"SEGUNDA_FEIRA","openingTime":"10:00:57Z","closingTime":"16:00:57Z"}]}}]}]}
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' utilizada está em definição pelos participantes.
{"name":"Empresa da Marca A","cnpjNumber":"45086338000178","phoneChannels":[{"identification":{"type":"OUVIDORIA","phones":[{"countryCallingCode":"55","areaCode":"19","number":"08007787788"}]},"services":[{"name":"AVISO_SINISTRO","code":"01"}],"availability":{"standards":[{"weekday":"SEGUNDA_FEIRA","openingTime":"10:00:57Z","closingTime":"16:00:57Z"}]}}]}
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Instituição, pertencente à organização, responsável pelo Canal Telefônico.
cnpjNumber
string
true
none
Número completo do CNPJ da instituição responsável pela dependência - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. Deve-se ter apenas os números do CNPJ, sem máscara
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","identification":[{"name":"Empresa B","cnpjNumber":12341234123412,"products":[{"code":"01234589-0","name":"Produto de Seguro","coverage":["string"]}],"postalAddress":[{"address":"'Rua Diamantina, 59, bloco 35' Praça da Boa Vontade, s/n","additionalInfo":"Loja B","districtName":"Paraíso","townName":"São Paulo","ibgeCode":"string","countrySubDivision":"AC","postCode":1310200,"country":"ANDORRA","countryCode":"BRA","geographicCoordinates":{"latitude":-89.836518,"longitude":-179.836519}}],"access":[{"standards":[{"openingTime":"10:00:57Z","closingTime":"16:00:57Z","weekday":"DOMINGO"}],"restrictionIndicator":false,"phones":[{"type":"FIXO","countryCallingCode":55,"areaCode":11,"number":30041000}]}],"services":[{"type":"ASSISTENCIA_AUTO","typeOthers":"string","name":["ACIONAMENTO_E_OU_AGENDAMENTO_DE_LEVA_E_TRAZ"],"description":"string"}]}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes
Deverá trazer toda a informação referente ao endereço do intermediário: Tipo de logradouro + Nome do logradouro + Número do Logradouro (se não existir usar ' s/n') + complemento (se houver), como, p.ex.: 'R Diamantina, 59, bloco 35, fundos’ 'Praça da Boa Vontade s/n
additionalInfo
string
false
none
Alguns logradouros ainda necessitam ser especificados por meio de complemento, conforme o exemplo a seguir: 'Loja B', 'Fundos', 'Casa 2', 'Lote C'
districtName
string
false
none
Bairro é uma comunidade ou região localizada em uma cidade ou município de acordo com as suas subdivisões geográficas. p.ex: 'Paraíso'
townName
string
true
none
Localidade: O nome da localidade corresponde à designação da cidade ou município no qual o endereço está localizado. p.ex. 'São Paulo'
ibgeCode
string
true
none
7 dígitos (o último é um código verificador).
countrySubDivision
string
true
none
Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. p.ex. 'AC'. São consideradas apenas as siglas para os estados brasileiros:
postCode
string
true
none
Código de Endereçamento Postal: Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios. p.ex. '01311000'
country
string
false
none
Lista de países vide aba 'Lista de países'
countryCode
string
false
none
Código do país de acordo com o código “alpha3” do ISO-3166. p.ex.'BRA'
Informação da Latitude referente a geolocalização informada. Entre -90 e 90. Formato numérico 2 casas antes da vírgula, 11 posições. p.ex. '-89.8365180'
longitude
string
false
none
Informação da Longitude referente a geolocalização informada. Formato numérico 3 casas antes da vírgula, 11 posições. Entre -180 e 180. p.ex'-179.836519.'
Relação dos tipos de prestação de serviços efetivamente prestados, conforme discriminado na Tabela XXX do Anexo II
typeOthers
string
false
none
Descrição de serviços efetuados no tipo de prestação de serviços CASO PREENCHIDO A OPÇÃO OUTRAS. Deve ser padronizada na proposta técnica submetida pela Estrutura Inicial de Governança para observância comum por todas as sociedades participantes
name
[string]
true
none
Relação dos serviços efetivamente prestados, conforme discriminado na Tabela II.5 do Anexo II
description
string
true
none
Campo aberto para detalhamento do tipo de serviço prestado.
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","securityType":["SMARTPHONE"],"securityTypeOthers":"string","coverages":[{"coverage":"SERVICOS_EMERGENCIAIS","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"traits":true,"microInsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["REDE_REFERENCIADA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Bens em geral. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo Garantia Estendida - Auto
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"GARANTIA_ESTENDIDA_ORIGINAL","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["LINHA_BRANCA"],"securityTypeOthers":"string","assistanceServices":{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"},"customerServices":"REDE_REFERENCIADA","microinsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Garantia Estendida - Auto. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"microInsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":"A_VISTA","premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Empresarial. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtém a lista dos produtos do tipo título de capitalização
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"requestTime":"2021-08-20T08:30:00Z","brand":{"name":"ACME seguros","companies":[{"name":"ACME cap da ACME seguros","cnpjNumber":"12345678901234","products":[{"name":"ACMEcap","code":"01234589_cap","modality":["TRADICIONAL"],"costType":["PAGAMENTO_UNICO"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"termsRegulations":"https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"},"quotas":[{"quota":10,"capitalizationQuota":[10],"raffleQuota":[10],"chargingQuota":[10]}],"validity":48,"serieSize":5000000,"capitalizationPeriod":{"interestRate":0.25123,"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"],"contributionAmount":{"minValue":500,"maxValue":5000,"frequency":"MENSAL","value":0},"earlyRedemption":[{"quota":0,"percentage":0}],"redemptionPercentageEndTerm":100.002,"gracePeriodRedemption":48},"latePayment":{"suspensionPeriod":10,"termExtensionOption":true},"contributionPayment":{"paymentMethod":["CARTAO_CREDITO"],"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"]},"redemption":{"redemption":151.23},"raffle":{"raffleQty":10000,"timeInterval":["QUINZENAL"],"raffleValue":5,"earlySettlementRaffle":true,"mandatoryContemplation":true,"ruleDescription":"Sorteio às quartas-feiras","minimumContemplationProbability":0.000001},"additionalDetails":{"additionalDetails":"https://example.com/openinsurance"},"minimumRequirements":{"minimumRequirementDetails":"https://ey.exemplo/capitalizacao/tradicional/PU/requisitos_min","targetAudiences":["PESSOAL_NATURAL"]}}]}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"string","next":"string","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"COBERTURA_BASICA_AMPLA_COBERTURAS_PARA_QUAISQUER_EVENTOS_QUE_POSSAM_CAUSAR_DANOS_FISICOS_AO_IMOVEL_SEGURADO_EXCETO_OS_EXPRESSAMENTE_EXCLUIDOS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"propertyType":[{"insuredPropertyType":"CONDOMINIO_RESIDENCIAL","structuringType":"CONDOMINIO_HORIZONTAL"}],"commercializationArea":0,"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"microInsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Condominio. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo Risco Cibernético
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"RESPONSABILIDADE_CIVIL_PERANTE_TERCEIROS","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"maxLA":{},"insuredParticipation":[],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"maxLMGDescription":"string","maxLMG":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["REDE_REFERENCIADA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Risco Cibernético. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo DirectorsOfficersLiability
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"DANOS_CAUSADOS_A_TERCEIROS_EM_CONSEQUENCIA_DE_ATOS_ILICITOS_CULPOSOS_PRATICADOS_NO_EXERCICIO_DAS_FUNCOES_PARA_AS_QUAIS_TENHA_SIDO_NOMEADO_ELEITO_OU_CONTRATADO_E_OBRIGADO_A_INDENIZA_LOS_POR_DECISAO_JUDICIAL_OU_DECISAO_EM_JUIZO_ARBITRAL_OU_POR_ACORDO_COM_OS_TERCEIROS_PREJUDICADOS_MEDIANTE_A_ANUENCIA_DA_SOCIEDADE_SEGURADORA_DESDE_QUE_ATENDIDAS_AS_DISPOSICOES_DO_CONTRATO","coverageDescription":"string","coverageAttributes":{"maxLMI":0,"insuredParticipation":[],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"maxLMGDescription":"string","maxLMG":0,"traits":true,"customerServices":"REDE_REFERENCIADA","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"validity":[{"term":["ANUAL"],"termOthers":"Cobertura XYZ com vigência diferente da vigência da apólice"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Obtem a lista dos produtos do tipo Credito Interno
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"NAO_PAGAMENTO_DA_CARTEIRA_DE_CLIENTES_DO_SEGURADO","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":[["PESSOA_NATURAL"]]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Credito Interno. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"microinsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Engenharia. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo EnvironmentalLiability
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"INSTALACOES_FIXAS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMGDescription":"string","maxLMG":1000,"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["LIVRE ESCOLHA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Responsabilidade Ambiental. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ROUBO","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["SMARTPHONE"],"securityTypeOthers":"string","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"customerServices":["LIVRE ESCOLHA"],"microInsurance":true,"traits":true,"premiumPayment":{"paymentMethod":["CARTAO_DE_CREDITO"],"paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":["string"]},"validity":[{"term":["ANUAL"],"termOthers":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto RD Equipamento. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo ErrorsOmissionsLiability
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","professionalClass":"ADMINISTRADOR_IMOBILIARIO","professionalClassOthers":"string","coverages":[{"coverage":"RESPONSABILIZACAO_CIVIL_VINCULADA_A_PRESTACAO_DE_SERVICOS_PROFISSIONAIS_OBJETO_DA_ATIVIDADE_DO_SEGURADO","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMG":0,"maxLMGDescription":"string","customerServices":"REDE_REFERENCIADA","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto RD E&O. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo Credito à Exportação
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"COBERTURAS_DETALHAMENTO_CONDICOES_ESPECIAIS_E_PARTICULARES","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":[["PESSOA_NATURAL"]]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Credito à Exportação. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo Garantia Estendida
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"GARANTIA_ESTENDIDA_ORIGINAL","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["LINHA_BRANCA"],"securityTypeOthers":"string","assistanceServices":{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"},"customerServices":"REDE_REFERENCIADA","microinsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Garantia Estendida. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo Risco Financeiro
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"PROTECAO_DE_BENS","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Risco Financeiro. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo GeneralLiability
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ALAGAMENTO_E_OU_INUNDACAO","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{},"maxLA":{},"insuredParticipation":[],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMGDescription":"string","maxLMG":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"customerServices":["REDE_REFERENCIADA"],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto RC Geral. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo Global de Bancos
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Global de Bancos. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
GET /home-insurance/commercializationArea/{commercializationArea}
Obtém informações de seguros redidenciais
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
commercializationArea
path
string
true
Area de comercialização.
Example responses
200 Response
{"data":{"brand":{"name":"EMPRESA A seguros","company":[{"name":"ABCDE SEGUROS","cnpjNumber":12345678901234,"products":[{"name":"RESIDENCIAL XPTO","code":"0000-0","coverages":[{"coverageType":"Escritório em Residência","coverageDetail":"Cobertura especial para escritório residenciais","coveragePermissionSeparteAquisition":false,"coverageAttributes":{"minLMI":{},"maxLMI":{},"minDeductibleAmount":{},"insuredMandatoryParticipationPercentage":0}}],"propertyCharacteristics":[{"propertyType":"CASA","propertyBuildType":"ALVENARIA","propertyUsageType":"HABITUAL","destinationInsuredImportance":"PREDIO"}],"propertyZipCode":"1311000","protective":true,"additional":["SORTEIO_GRATUITO"],"additionalOthers":"string","assistanceServices":[{"assistanceServicesPackage":"ATE_10_SERVICOS","complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITA"}],"microInsurance":true,"termsAndConditions":[{"susepProcessNumber":"XXXXX.XXXXXX/XXXX-XX","definition":"https://openinsurance.com.br/aaa"}],"validity":[{"term":"ANUAL","termOthers":"string"}],"customerServices":["LIVRE_ESCOLHA"],"premiumRates":["string"],"premiumPayments":[{"paymentMethod":"CARTAO_CREDITO","paymentMethodDetail":"string","paymentType":"PAGAMENTO_UNICO"}],"minimumRequirements":[{"contractingType":"COLETIVO","contractingMinRequirement":"https://openinsurance.com.br/aaa"}],"targetAudiences":["PESSOA_NATURAL"]}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"string","next":"string","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"Empresa da Organização A","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"DANOS_ELETRICOS","coverageDescription":"string","allowApartPurchase":true,"coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"}}],"additional":["SORTEIO_GRATUITO"],"additionalOthers":"string","termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"minimumRequirementDetails":"string","targetAudiences":["PESSOA_FISICA"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"PERDA_DE_RECEITA_INTERRUPCAO_DE_NEGOCIOS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"microinsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Lucros Cessantes . Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo Riscos Nomeados e Operacionais
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ALAGAMENTO_INUNDACAO","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Riscos Nomeados e Operacionais. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo Demais Escopos - Petróleo, Nucleares, Marítimo e Aeronáutico.
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ABCDE Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"CASCO","coverageDescription":"string","allowApartPurchase":true,"coverageAttributes":{"maxLMI":{}}}],"traits":false,"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"validity":{"term":["ANUAL"],"termOthers":"string"},"premiumRates":["string"],"minimumRequirements":{"targetAudiences":["PESSOA_FISICA"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Demais Escopos. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtém informações de plano de previdência com cobertura de risco
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"requestTime":"2021-08-20T08:30:00Z","data":{},"brand":{"name":"EMPRESA","companies":{"name":"EMPRESA Seguros","cnpjNumber":45086338000178,"products":[{"name":"Nome comercial do Produto","code":"123456789_cap","modality":"PENSAO","coverages":[{"coverage":"INVALIDEZ","coveragesAttributes":{"indenizationPaymentMethod":"Pagamento Único","minValue":{"amount":0,"unit":{"code":"string","description":"string"}},"maxValue":{"amount":0,"unit":{"code":"string","description":"string"}},"indemnifiablePeriod":"Prazo","indemnifiableDeadline":48,"currency":"BRL","gracePeriod":{"amount":0,"unit":"DIAS"},"excludedRisk":["ATO_RECONHECIMENTO_PERIGOSO"],"excludedRiskURL":"string"},"coveragePeriod":"Vitalícia"}],"additional":"SORTEIO","additionalOthers":"string","assistanceType":["Funeral"],"assistanceTypeOthers":["string"],"termAndCondition":[{"susepProcessNumber":"15414.622222/2222-22","definition":"wwww.seguradora.com.br/termos"}],"updatePMBaC":{"interestRate":14,"updateIndex":"IPCA(IBGE)"},"premiumUpdateIndex":"IPCA","ageReframing":{"reframingCriterion":"Após período em anos","reframingPeriodicity":10},"financialRegimeContractType":"Repartição Simples","reclaim":{"reclaimTable":[{"initialMonthRange":0,"finalMonthRange":0,"percentage":"string"}],"differentiatedPercentage":"string","gracePeriod":"20/Não se aplica"},"otherGuarateedValues":"Saldamento","profitModality":"PAGAMENTO_UNICO","contributionPayment":{"contributionPaymentMethod":["Cartão de crédito"],"contributionPeriodicity":["Mensal"]},"contributionTax":"string","minimumRequirements":{"minRequirementsContractType":"Individual","minRequirementsContract":"wwww.seguradora.com.br/termos"},"targetAudience":"Pessoa Natural"}]}},"linksPaginated":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"string","next":"string","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"metaPaginated":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Obtem a lista dos produtos do tipo Garantia Privada
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"CONSTRUCAO_OBRAS","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Garantia Privada. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo Garantia Pública
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"LICITANTE","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":"A_VISTA","premiumRates":["string"]}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Garantia Pública. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"NAO_PAGAMENTO_DE_13_ALUGUEL","coverageDescription":"string","coverageAttributes":{"insuredParticipation":[],"insuredParticipationDescription":"string","maxLMI":"string"},"allowApartPurchase":true}],"traits":true,"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"customerServices":["LIVRE ESCOLHA"],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Financa Locaticia. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo Rural - Seguro Agrícola com cobertura do FESR, Seguro Agrícola sem cobertura do FESR, Seguro Florestas sem cobertura do FESR, Seguro Pecuário com cobertura do FESR, Seguro Pecuário sem cobertura do FESR, Seguros Animais, Penhor Rural e Seguro Benfeitorias, Produtos Agropecuários, Penhor Rural, Seguro Benfeitorias, Produtos Agropecuários e Seguro de Vida do Produtor Rural.
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"EMPRESA A seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","modality":"AGRICOLA","coverages":[{"coverage":"GRANIZO","coverageDescription":"string","allowApartPurchase":true,"coverageAttributes":{"insuredParticipation":[],"insuredParticipationDescription":"string"}}],"maxLMG":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"traits":false,"crops":["FRUTAS"],"cropsOthers":"string","forestCode":["PINUS"],"forestCodeOthers":"string","flockCode":["BOVINOS"],"flockCodeOthers":"string","animalDestination":["PRODUCAO"],"animalsClassification":["ELITE"],"subvention":true,"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"validity":{"term":["ANUAL"],"termOthers":"string"},"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"minimumRequirements":{"contractType":"COLETIVO","minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_FISICA"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
Dados dos produtos de Rural - Seguro Agrícola com cobertura do FESR, Seguro Agrícola sem cobertura do FESR, Seguro Florestas sem cobertura do FESR, Seguro Pecuário com cobertura do FESR, Seguro Pecuário sem cobertura do FESR e Seguros Animais
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Rural. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados. - Seguro Agrícola com cobertura do FESR, Seguro Agrícola sem cobertura do FESR, Seguro Florestas sem cobertura do FESR, Seguro Pecuário com cobertura do FESR, Seguro Pecuário sem cobertura do FESR e Seguros Animais
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"STOP_LOSS","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Stop Loss. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados.
Obtem a lista dos produtos do tipo Transport - RCA-C, RCF-DC, RCOTM-C, RCTA-C, RCTF-C, RCTR-C, RCTR-VI-C, Carta Azul, Transporte Internacional, Nacional e Ônibus
Parameters
Name
In
Type
Required
Description
cache-control
header
string
true
Controle de cache para evitar que informações confidenciais sejam armazenadas em cache.
Content-Security-Policy
header
string
false
Campo para proteção contra ataques clickjack do estilo - drag and drop.
content-Type
header
string
false
Especificar o tipo de conteúdo da resposta.
Strict-Transport-Security
header
string
false
Campo para exigir conexões por HTTPS e proteger contra certificados falsificados.
X-Content-Type-Options
header
string
false
Campo para evitar que navegadores executem a detecção de MIME e interpretem respostas como HTML de forma inadequada.
X-Frame-Options
header
string
false
Campo indica se o navegador deve ou não renderizar um frame.
page
query
integer
false
Número da página que está sendo requisitada (o valor da primeira página é 1).
page-size
query
integer
false
Quantidade total de registros por páginas.
Example responses
200 Response
{"data":{"brand":{"name":"EMPRESA A seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ACIDENTES_PESSOAIS_COM_PASSAGEIROS","coverageDescription":"string","allowApartPurchase":true,"coverageAttributes":{"insuredParticipation":[],"insuredParticipationDescription":"string"}}],"maxLMG":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"traits":false,"validity":{"term":["ANUAL"],"termOthers":"string"},"premiumRates":"string","policyType":["AVULSA"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"minimumRequirementDetails":"string","targetAudiences":[["PESSOA_FISICA"]]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Dados dos produtos de API de informações de dados do produto Transportes. Os recursos que podem ser consumidos pelos participantes conforme a regra 3.1.2 do manual de escopo de dados. - RCA-C, RCF-DC, RCOTM-C, RCTA-C, RCTF-C, RCTR-C, RCTR-VI-C, Carta Azul, Transporte Internacional, Nacional e Ônibus
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","securityType":["SMARTPHONE"],"securityTypeOthers":"string","coverages":[{"coverage":"SERVICOS_EMERGENCIAIS","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"traits":true,"microInsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["REDE_REFERENCIADA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","securityType":["SMARTPHONE"],"securityTypeOthers":"string","coverages":[{"coverage":"SERVICOS_EMERGENCIAIS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"traits":true,"microInsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["REDE_REFERENCIADA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"Produto de Seguro","code":"01234589-0","securityType":["SMARTPHONE"],"securityTypeOthers":"string","coverages":[{"coverage":"SERVICOS_EMERGENCIAIS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"traits":true,"microInsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["REDE_REFERENCIADA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
securityType
[string]
true
none
Listagem de tipo de bem segurado
securityTypeOthers
string
false
none
Campo livre para descrição, caso o valor do campo "Tipo de bem segurado" seja 12. Outros
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conformeTabela II.8 do Anexo II.
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
Properties
Name
Type
Required
Restrictions
Description
assistanceServices
boolean
true
none
Indicação se o produto possui serviços de assistências complementares.
assistanceServicesPackage
[string]
false
none
none
complementaryAssistanceServicesDetail
string
false
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
false
none
Indicação se o pacote de Assistência é gratuita ou contratada/paga.
Enumerated Values
Property
Value
chargeTypeSignaling
GRATUITO
chargeTypeSignaling
PAGO
AssistanceGeneralAssetsValidity
[{"term":["ANUAL"],"termOthers":"string"}]
Properties
Name
Type
Required
Restrictions
Description
term
[string]
true
none
none
termOthers
string
false
none
Campo livre para descrição por cada participante ao selecionar o domínio “Outros” no campo Prazo (acima).
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"GARANTIA_ESTENDIDA_ORIGINAL","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["LINHA_BRANCA"],"securityTypeOthers":"string","assistanceServices":{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"},"customerServices":"REDE_REFERENCIADA","microinsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"GARANTIA_ESTENDIDA_ORIGINAL","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["LINHA_BRANCA"],"securityTypeOthers":"string","assistanceServices":{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"},"customerServices":"REDE_REFERENCIADA","microinsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"GARANTIA_ESTENDIDA_ORIGINAL","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["LINHA_BRANCA"],"securityTypeOthers":"string","assistanceServices":{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"},"customerServices":"REDE_REFERENCIADA","microinsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"GARANTIA_ESTENDIDA_ORIGINAL","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["LINHA_BRANCA"],"securityTypeOthers":"string","assistanceServices":{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"},"customerServices":"REDE_REFERENCIADA","microinsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.8 do Anexo II.
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
Indicação se o produto possui serviços de assistências complementares
assistanceServicesPackage
[string]
false
none
Para efeitos de comparabilidade, considerar agrupamentos de serviços em 4 categorias
complementaryAssistanceServicesDetail
string
false
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
false
none
Serviços de Assistências Complementares - Tipo de cobrança
Enumerated Values
Property
Value
chargeTypeSignaling
GRATUITO
chargeTypeSignaling
PAGO
AutoExtendedWarrantyValidity
[{"term":["ANUAL"],"termOthers":"string"}]
Properties
Name
Type
Required
Restrictions
Description
term
[string]
true
none
none
termOthers
string
false
none
Campo livre para descrição por cada participante ao selecionar o domínio “Outros” no campo Prazo (acima).
Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
Listagem de modelos / ano de veículos. Deve ser padronizada na proposta técnica submetida pela Estrutura Inicial de Governança para observância comum por todas as sociedades participantes.
vehicleOvernightZipCode
string
true
none
Área de comercialização do seguro do automóvel.
additional
[string]
true
none
none
additionalOthers
string
false
none
Campo aberto para descrição de cada participante ao selecionar o domínio ‘Outros’ no campo acima ‘Adicionais’
Listagem percentual de franquia e/ou percentual de participação obrigatória do segurado estabelecida pela sociedade para cada tipo de cobertura de produto.
mandatoryParticipation
string
true
none
Participação Obrigatória do Segurado.
geographicScopeCoverage
[string]
true
none
Listagem de abrangência geográfica do produto para fins de cada cobertura.
Listagem de modelos / ano de veículos. Deve ser padronizada na proposta técnica submetida pela Estrutura Inicial de Governança para observância comum por todas as sociedades participantes.
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"microInsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":"A_VISTA","premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"INCENDIO_QUEDA_DE_RAIO_E_EXPLOSAO","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["POS"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"microInsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":"A_VISTA","premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
Properties
Name
Type
Required
Restrictions
Description
assistanceServices
boolean
true
none
O produto possui assistências?
assistanceServicesPackage
[string]
false
none
none
complementaryAssistanceServicesDetail
string
false
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
false
none
Indicação se o pacote de Assistência é gratuita ou contratada/paga.
Enumerated Values
Property
Value
chargeTypeSignaling
GRATUITO
chargeTypeSignaling
PAGO
BusinessValidity
[{"term":["ANUAL"],"termOthers":"string"}]
Properties
Name
Type
Required
Restrictions
Description
term
[string]
true
none
none
termOthers
string
false
none
Campo livre para descrição por cada participante ao selecionar o domínio “Outros” no campo Prazo (acima).
{"requestTime":"2021-08-20T08:30:00Z","brand":{"name":"ACME seguros","companies":[{"name":"ACME cap da ACME seguros","cnpjNumber":"12345678901234","products":[{"name":"ACMEcap","code":"01234589_cap","modality":["TRADICIONAL"],"costType":["PAGAMENTO_UNICO"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"termsRegulations":"https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"},"quotas":[{"quota":10,"capitalizationQuota":[10],"raffleQuota":[10],"chargingQuota":[10]}],"validity":48,"serieSize":5000000,"capitalizationPeriod":{"interestRate":0.25123,"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"],"contributionAmount":{"minValue":500,"maxValue":5000,"frequency":"MENSAL","value":0},"earlyRedemption":[{"quota":0,"percentage":0}],"redemptionPercentageEndTerm":100.002,"gracePeriodRedemption":48},"latePayment":{"suspensionPeriod":10,"termExtensionOption":true},"contributionPayment":{"paymentMethod":["CARTAO_CREDITO"],"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"]},"redemption":{"redemption":151.23},"raffle":{"raffleQty":10000,"timeInterval":["QUINZENAL"],"raffleValue":5,"earlySettlementRaffle":true,"mandatoryContemplation":true,"ruleDescription":"Sorteio às quartas-feiras","minimumContemplationProbability":0.000001},"additionalDetails":{"additionalDetails":"https://example.com/openinsurance"},"minimumRequirements":{"minimumRequirementDetails":"https://ey.exemplo/capitalizacao/tradicional/PU/requisitos_min","targetAudiences":["PESSOAL_NATURAL"]}}]}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"string","next":"string","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
Properties
Name
Type
Required
Restrictions
Description
requestTime
string(date-time)
false
none
Data e hora da consulta, conforme especificação RFC-3339, formato UTC.
{"name":"ACME seguros","companies":[{"name":"ACME cap da ACME seguros","cnpjNumber":"12345678901234","products":[{"name":"ACMEcap","code":"01234589_cap","modality":["TRADICIONAL"],"costType":["PAGAMENTO_UNICO"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"termsRegulations":"https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"},"quotas":[{"quota":10,"capitalizationQuota":[10],"raffleQuota":[10],"chargingQuota":[10]}],"validity":48,"serieSize":5000000,"capitalizationPeriod":{"interestRate":0.25123,"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"],"contributionAmount":{"minValue":500,"maxValue":5000,"frequency":"MENSAL","value":0},"earlyRedemption":[{"quota":0,"percentage":0}],"redemptionPercentageEndTerm":100.002,"gracePeriodRedemption":48},"latePayment":{"suspensionPeriod":10,"termExtensionOption":true},"contributionPayment":{"paymentMethod":["CARTAO_CREDITO"],"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"]},"redemption":{"redemption":151.23},"raffle":{"raffleQty":10000,"timeInterval":["QUINZENAL"],"raffleValue":5,"earlySettlementRaffle":true,"mandatoryContemplation":true,"ruleDescription":"Sorteio às quartas-feiras","minimumContemplationProbability":0.000001},"additionalDetails":{"additionalDetails":"https://example.com/openinsurance"},"minimumRequirements":{"minimumRequirementDetails":"https://ey.exemplo/capitalizacao/tradicional/PU/requisitos_min","targetAudiences":["PESSOAL_NATURAL"]}}]}]}
Organização controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME cap da ACME seguros","cnpjNumber":"12345678901234","products":[{"name":"ACMEcap","code":"01234589_cap","modality":["TRADICIONAL"],"costType":["PAGAMENTO_UNICO"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"termsRegulations":"https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"},"quotas":[{"quota":10,"capitalizationQuota":[10],"raffleQuota":[10],"chargingQuota":[10]}],"validity":48,"serieSize":5000000,"capitalizationPeriod":{"interestRate":0.25123,"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"],"contributionAmount":{"minValue":500,"maxValue":5000,"frequency":"MENSAL","value":0},"earlyRedemption":[{"quota":0,"percentage":0}],"redemptionPercentageEndTerm":100.002,"gracePeriodRedemption":48},"latePayment":{"suspensionPeriod":10,"termExtensionOption":true},"contributionPayment":{"paymentMethod":["CARTAO_CREDITO"],"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"]},"redemption":{"redemption":151.23},"raffle":{"raffleQty":10000,"timeInterval":["QUINZENAL"],"raffleValue":5,"earlySettlementRaffle":true,"mandatoryContemplation":true,"ruleDescription":"Sorteio às quartas-feiras","minimumContemplationProbability":0.000001},"additionalDetails":{"additionalDetails":"https://example.com/openinsurance"},"minimumRequirements":{"minimumRequirementDetails":"https://ey.exemplo/capitalizacao/tradicional/PU/requisitos_min","targetAudiences":["PESSOAL_NATURAL"]}}]}]
[{"name":"ACMEcap","code":"01234589_cap","modality":["TRADICIONAL"],"costType":["PAGAMENTO_UNICO"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"termsRegulations":"https://ey.exemplo/capitalizacao/tradicional/pdf/condicoes_gerais.pdf"},"quotas":[{"quota":10,"capitalizationQuota":[10],"raffleQuota":[10],"chargingQuota":[10]}],"validity":48,"serieSize":5000000,"capitalizationPeriod":{"interestRate":0.25123,"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"],"contributionAmount":{"minValue":500,"maxValue":5000,"frequency":"MENSAL","value":0},"earlyRedemption":[{"quota":0,"percentage":0}],"redemptionPercentageEndTerm":100.002,"gracePeriodRedemption":48},"latePayment":{"suspensionPeriod":10,"termExtensionOption":true},"contributionPayment":{"paymentMethod":["CARTAO_CREDITO"],"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"]},"redemption":{"redemption":151.23},"raffle":{"raffleQty":10000,"timeInterval":["QUINZENAL"],"raffleValue":5,"earlySettlementRaffle":true,"mandatoryContemplation":true,"ruleDescription":"Sorteio às quartas-feiras","minimumContemplationProbability":0.000001},"additionalDetails":{"additionalDetails":"https://example.com/openinsurance"},"minimumRequirements":{"minimumRequirementDetails":"https://ey.exemplo/capitalizacao/tradicional/PU/requisitos_min","targetAudiences":["PESSOAL_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
Os títulos de capitalização que prevejam sorteio devem ser estruturados em series, ou seja, em sequencias ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.
Percentual da contribuição destinado à constituição de capital referente ao direito de resgate.
raffleQuota
[number]
true
none
Percentual da contribuição designado a custear os sorteios, se previstos no plano
chargingQuota
[number]
true
none
Percentual da contribuição destinado aos custos de despesas com corretagem, colocação e administração do título de capitalização, emissão, divulgação, lucro da sociedade de capitalização e eventuais despesas relavas ao custeio da contemplação obrigatória e da distribuição de bônus.
CapitalizationTitleValidity
48
Prazo de vigência do título de capitalização em meses.
Properties
Name
Type
Required
Restrictions
Description
anonymous
integer
false
none
Prazo de vigência do título de capitalização em meses.
CapitalizationTitleSerieSize
5000000
Os títulos de capitalização que prevejam sorteio devem ser estruturados em series, ou seja, em sequencias ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.
Properties
Name
Type
Required
Restrictions
Description
anonymous
integer
false
none
Os títulos de capitalização que prevejam sorteio devem ser estruturados em series, ou seja, em sequencias ou em grupos de títulos submetidos às mesmas condições e características, à exceção do valor do pagamento.
CapitalizationTitlePeriod
{"interestRate":0.25123,"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"],"contributionAmount":{"minValue":500,"maxValue":5000,"frequency":"MENSAL","value":0},"earlyRedemption":[{"quota":0,"percentage":0}],"redemptionPercentageEndTerm":100.002,"gracePeriodRedemption":48}
Período de Capitalização
Properties
Name
Type
Required
Restrictions
Description
interestRate
number
true
none
Taxa que remunera a parte da mensalidade destinada a formar o Capital, ou seja, a Provisão Matemática de Resgate, também chamada de saldo de capitalização. Em porcentagem ao mês (% a.m)
updateIndex
[string]
true
none
Índice utilizado na correção que remunera a provisão matemática para capitalização
updateIndexOthers
[string]
false
none
Preenchida pelas participantes quando houver ‘Outros’ no campo.
Possibilidade de o titular efetuar o resgate do capital constituído antes do fim do prazo de vigência do título, podendo ocorrer por solicitação expressa do titular ou por contemplação em sorteio com liquidação antecipada
» quota
integer
true
none
Número de parcela.
» percentage
number
true
none
Percentual da quota
redemptionPercentageEndTerm
number
true
none
Percentual mínimo da soma das contribuições efetuadas que poderá ser resgatado ao final da vigência, tendo como condição os pagamentos das parcelas nos respectivos vencimentos.
gracePeriodRedemption
integer
true
none
Intervalo de tempo mínimo entre contratação e resgate do direito, em meses.
Prazo máximo (contínuo ou intermitente) em meses que o título fica suspenso por atraso de pagamento, antes de ser cancelado (não aplicável a pagamento único).
termExtensionOption
boolean
true
none
Alteração do prazo de vigência original, pela suspensão.
CapitalizationTitleContributionPayment
{"paymentMethod":["CARTAO_CREDITO"],"updateIndex":["IPCA"],"updateIndexOthers":["Índice de atualização"]}
Pagamento da contribuição
Properties
Name
Type
Required
Restrictions
Description
paymentMethod
[string]
true
none
Meio de Pagamento utilizados para pagamento da contribuição.
updateIndex
[string]
true
none
Índice utilizado na atualização dos pagamentos mensais (para títulos com mais de 12 meses de vigência)
updateIndexOthers
[string]
false
none
Preenchida pelas participantes quando houver ‘Outros’ no campo.
CapitalizationTitleredemption
{"redemption":151.23}
Properties
Name
Type
Required
Restrictions
Description
redemption
number
true
none
Valor percentual (%) de resgate final permitido.
CapitalizationTitleRaffle
{"raffleQty":10000,"timeInterval":["QUINZENAL"],"raffleValue":5,"earlySettlementRaffle":true,"mandatoryContemplation":true,"ruleDescription":"Sorteio às quartas-feiras","minimumContemplationProbability":0.000001}
Sorteio
Properties
Name
Type
Required
Restrictions
Description
raffleQty
integer
true
none
Número da quantidade de sorteios previstos ao longo da vigência
timeInterval
[string]
true
none
Intervalo de tempo regular previsto entre os sorteios.
raffleValue
integer
true
none
Valor dos sorteios representado por múltiplo do valor de contribuição.
earlySettlementRaffle
boolean
true
none
Liquidação antecipada em Sorteio. Modelo de sorteio que acarreta, ao título contemplado, o seu resgate total obrigatório (Resolução Normativa 384/20).
mandatoryContemplation
boolean
true
none
Contemplação obrigatória. Possibilidade de realização de sorteio com previsão de que o título sorteado seja obrigatoriamente um título comercializado, desde que atingidos os requisitos definidos nas condições gerais do plano.
ruleDescription
string
false
none
Campo aberto para descrição a ser feita por cada participante das regras dos sorteios do produto.
minimumContemplationProbability
number
true
none
Número representativo da probabilidade mínima de contemplação nos sorteios, em porcentagem (%).
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"COBERTURA_BASICA_AMPLA_COBERTURAS_PARA_QUAISQUER_EVENTOS_QUE_POSSAM_CAUSAR_DANOS_FISICOS_AO_IMOVEL_SEGURADO_EXCETO_OS_EXPRESSAMENTE_EXCLUIDOS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"propertyType":[{"insuredPropertyType":"CONDOMINIO_RESIDENCIAL","structuringType":"CONDOMINIO_HORIZONTAL"}],"commercializationArea":0,"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"microInsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"COBERTURA_BASICA_AMPLA_COBERTURAS_PARA_QUAISQUER_EVENTOS_QUE_POSSAM_CAUSAR_DANOS_FISICOS_AO_IMOVEL_SEGURADO_EXCETO_OS_EXPRESSAMENTE_EXCLUIDOS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["POS"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"propertyType":[{"insuredPropertyType":"CONDOMINIO_RESIDENCIAL","structuringType":"CONDOMINIO_HORIZONTAL"}],"commercializationArea":0,"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"microInsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
Properties
Name
Type
Required
Restrictions
Description
assistanceServices
boolean
true
none
Indicação se o produto possui serviços de assistências complementares.
assistanceServicesPackage
[string]
false
none
none
complementaryAssistanceServicesDetail
string
false
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
false
none
Indicação se o pacote de Assistência é gratuita ou contratada/paga.
Enumerated Values
Property
Value
chargeTypeSignaling
GRATUITO
chargeTypeSignaling
PAGO
CondominiumValidity
[{"term":["ANUAL"],"termOthers":"string"}]
Properties
Name
Type
Required
Restrictions
Description
term
[string]
true
none
none
termOthers
string
false
none
Campo livre para descrição por cada participante ao selecionar o domínio “Outros” no campo Prazo (acima).
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"RESPONSABILIDADE_CIVIL_PERANTE_TERCEIROS","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"maxLA":{},"insuredParticipation":[],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"maxLMGDescription":"string","maxLMG":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["REDE_REFERENCIADA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"RESPONSABILIDADE_CIVIL_PERANTE_TERCEIROS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"maxLA":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"maxLMGDescription":"string","maxLMG":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["REDE_REFERENCIADA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"RESPONSABILIDADE_CIVIL_PERANTE_TERCEIROS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"maxLA":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"maxLMGDescription":"string","maxLMG":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["REDE_REFERENCIADA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"RESPONSABILIDADE_CIVIL_PERANTE_TERCEIROS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"maxLA":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"maxLMGDescription":"string","maxLMG":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["REDE_REFERENCIADA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.9 do Anexo II.
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
Valor máximo de LMG aceito pela sociedade para o produto.
traits
boolean
true
none
Indicação se o produto é classificado como destinado para cobertura de grandes riscos, sendo tal classificação de acordo com regulamentação específica.
Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
Properties
Name
Type
Required
Restrictions
Description
assistanceServices
boolean
true
none
Indicação se o produto possui serviços de assistências complementares.
assistanceServicesPackage
[string]
false
none
none
complementaryAssistanceServicesDetail
string
false
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
false
none
Indicação se o pacote de assistência é gratuito ou contratado/pago.
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"DANOS_CAUSADOS_A_TERCEIROS_EM_CONSEQUENCIA_DE_ATOS_ILICITOS_CULPOSOS_PRATICADOS_NO_EXERCICIO_DAS_FUNCOES_PARA_AS_QUAIS_TENHA_SIDO_NOMEADO_ELEITO_OU_CONTRATADO_E_OBRIGADO_A_INDENIZA_LOS_POR_DECISAO_JUDICIAL_OU_DECISAO_EM_JUIZO_ARBITRAL_OU_POR_ACORDO_COM_OS_TERCEIROS_PREJUDICADOS_MEDIANTE_A_ANUENCIA_DA_SOCIEDADE_SEGURADORA_DESDE_QUE_ATENDIDAS_AS_DISPOSICOES_DO_CONTRATO","coverageDescription":"string","coverageAttributes":{"maxLMI":0,"insuredParticipation":[],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"maxLMGDescription":"string","maxLMG":0,"traits":true,"customerServices":"REDE_REFERENCIADA","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"validity":[{"term":["ANUAL"],"termOthers":"Cobertura XYZ com vigência diferente da vigência da apólice"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"DANOS_CAUSADOS_A_TERCEIROS_EM_CONSEQUENCIA_DE_ATOS_ILICITOS_CULPOSOS_PRATICADOS_NO_EXERCICIO_DAS_FUNCOES_PARA_AS_QUAIS_TENHA_SIDO_NOMEADO_ELEITO_OU_CONTRATADO_E_OBRIGADO_A_INDENIZA_LOS_POR_DECISAO_JUDICIAL_OU_DECISAO_EM_JUIZO_ARBITRAL_OU_POR_ACORDO_COM_OS_TERCEIROS_PREJUDICADOS_MEDIANTE_A_ANUENCIA_DA_SOCIEDADE_SEGURADORA_DESDE_QUE_ATENDIDAS_AS_DISPOSICOES_DO_CONTRATO","coverageDescription":"string","coverageAttributes":{"maxLMI":0,"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"maxLMGDescription":"string","maxLMG":0,"traits":true,"customerServices":"REDE_REFERENCIADA","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"validity":[{"term":["ANUAL"],"termOthers":"Cobertura XYZ com vigência diferente da vigência da apólice"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"DANOS_CAUSADOS_A_TERCEIROS_EM_CONSEQUENCIA_DE_ATOS_ILICITOS_CULPOSOS_PRATICADOS_NO_EXERCICIO_DAS_FUNCOES_PARA_AS_QUAIS_TENHA_SIDO_NOMEADO_ELEITO_OU_CONTRATADO_E_OBRIGADO_A_INDENIZA_LOS_POR_DECISAO_JUDICIAL_OU_DECISAO_EM_JUIZO_ARBITRAL_OU_POR_ACORDO_COM_OS_TERCEIROS_PREJUDICADOS_MEDIANTE_A_ANUENCIA_DA_SOCIEDADE_SEGURADORA_DESDE_QUE_ATENDIDAS_AS_DISPOSICOES_DO_CONTRATO","coverageDescription":"string","coverageAttributes":{"maxLMI":0,"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"maxLMGDescription":"string","maxLMG":0,"traits":true,"customerServices":"REDE_REFERENCIADA","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"validity":[{"term":["ANUAL"],"termOthers":"Cobertura XYZ com vigência diferente da vigência da apólice"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"DANOS_CAUSADOS_A_TERCEIROS_EM_CONSEQUENCIA_DE_ATOS_ILICITOS_CULPOSOS_PRATICADOS_NO_EXERCICIO_DAS_FUNCOES_PARA_AS_QUAIS_TENHA_SIDO_NOMEADO_ELEITO_OU_CONTRATADO_E_OBRIGADO_A_INDENIZA_LOS_POR_DECISAO_JUDICIAL_OU_DECISAO_EM_JUIZO_ARBITRAL_OU_POR_ACORDO_COM_OS_TERCEIROS_PREJUDICADOS_MEDIANTE_A_ANUENCIA_DA_SOCIEDADE_SEGURADORA_DESDE_QUE_ATENDIDAS_AS_DISPOSICOES_DO_CONTRATO","coverageDescription":"string","coverageAttributes":{"maxLMI":0,"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"maxLMGDescription":"string","maxLMG":0,"traits":true,"customerServices":"REDE_REFERENCIADA","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"validity":[{"term":["ANUAL"],"termOthers":"Cobertura XYZ com vigência diferente da vigência da apólice"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
Indicação se a cobertura permite contratação separada
maxLMGDescription
string
true
none
Descritivo da composição do Limite Máximo de Garantia (LMG) por cobertura
maxLMG
number
true
none
Lista com valor de LMG aceito pela sociedade para cada produto
traits
boolean
true
none
Indicação se o produto é classificado como destinado para cobertura de grandes riscos, sendo tal classificação de acordo com regulamentação específica.
Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
Properties
Name
Type
Required
Restrictions
Description
assistanceServices
boolean
true
none
Indicação se o produto possui serviços de assistências complementares.
assistanceServicesPackage
[any]
false
none
none
complementaryAssistanceServicesDetail
string
false
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
false
none
Indicação se o pacote de assistência é gratuito ou contratado/pago..
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"NAO_PAGAMENTO_DA_CARTEIRA_DE_CLIENTES_DO_SEGURADO","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":[["PESSOA_NATURAL"]]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"NAO_PAGAMENTO_DA_CARTEIRA_DE_CLIENTES_DO_SEGURADO","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":[["PESSOA_NATURAL"]]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"NAO_PAGAMENTO_DA_CARTEIRA_DE_CLIENTES_DO_SEGURADO","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":[["PESSOA_NATURAL"]]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"NAO_PAGAMENTO_DA_CARTEIRA_DE_CLIENTES_DO_SEGURADO","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":[["PESSOA_NATURAL"]]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.12 do Anexo II
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"microinsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"microinsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"microinsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"OBRAS_CIVIS_CONSTRUCAO_E_INSTALACAO_E_MONTAGEM","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"microinsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
false
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
Faixa de Preço, conforme estabelecido no inciso VII do Art. 2º do Anexo III da Circular SUSEP 635/2021, inclusive sobre sua faculdade para alguns produtos
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"INSTALACOES_FIXAS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMGDescription":"string","maxLMG":1000,"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["LIVRE ESCOLHA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"INSTALACOES_FIXAS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMGDescription":"string","maxLMG":1000,"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["LIVRE ESCOLHA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"INSTALACOES_FIXAS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMGDescription":"string","maxLMG":1000,"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"customerServices":["LIVRE ESCOLHA"],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
Indicação se a cobertura permite contratação separada (por cobertura selecionada).
traits
boolean
true
none
Indicação se o produto é classificado como destinado para cobertura de grandes riscos, sendo tal classificação de acordo com regulamentação específica.
maxLMGDescription
string
true
none
Descritivo da composição do Limite Máximo de Garantia (LMG) por cobertura
maxLMG
number
true
none
Valor máximo de LMG aceito pela sociedade para o produto.
Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
Properties
Name
Type
Required
Restrictions
Description
assistanceServices
boolean
true
none
Indicação se o produto possui serviços de assistências complementares.
assistanceServicesPackage
[string]
false
none
none
complementaryAssistanceServicesDetail
string
false
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
false
none
Indicação se o pacote de assistência é gratuito ou contratado/pago.
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ROUBO","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["SMARTPHONE"],"securityTypeOthers":"string","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"customerServices":["LIVRE ESCOLHA"],"microInsurance":true,"traits":true,"premiumPayment":{"paymentMethod":["CARTAO_DE_CREDITO"],"paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":["string"]},"validity":[{"term":["ANUAL"],"termOthers":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ROUBO","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["SMARTPHONE"],"securityTypeOthers":"string","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"customerServices":["LIVRE ESCOLHA"],"microInsurance":true,"traits":true,"premiumPayment":{"paymentMethod":["CARTAO_DE_CREDITO"],"paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":["string"]},"validity":[{"term":["ANUAL"],"termOthers":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ROUBO","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["SMARTPHONE"],"securityTypeOthers":"string","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"customerServices":["LIVRE ESCOLHA"],"microInsurance":true,"traits":true,"premiumPayment":{"paymentMethod":["CARTAO_DE_CREDITO"],"paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":["string"]},"validity":[{"term":["ANUAL"],"termOthers":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ROUBO","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["SMARTPHONE"],"securityTypeOthers":"string","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"customerServices":["LIVRE ESCOLHA"],"microInsurance":true,"traits":true,"premiumPayment":{"paymentMethod":["CARTAO_DE_CREDITO"],"paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":["string"]},"validity":[{"term":["ANUAL"],"termOthers":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.8 do Anexo II.
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
Properties
Name
Type
Required
Restrictions
Description
assistanceServices
boolean
true
none
Indicação se o produto possui serviços de assistências complementares.
assistanceServicesPackage
[string]
false
none
none
complementaryAssistanceServicesDetail
string
false
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
false
none
Serviços de Assistências Complementares - Tipo de cobrança
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","professionalClass":"ADMINISTRADOR_IMOBILIARIO","professionalClassOthers":"string","coverages":[{"coverage":"RESPONSABILIZACAO_CIVIL_VINCULADA_A_PRESTACAO_DE_SERVICOS_PROFISSIONAIS_OBJETO_DA_ATIVIDADE_DO_SEGURADO","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMG":0,"maxLMGDescription":"string","customerServices":"REDE_REFERENCIADA","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","professionalClass":"ADMINISTRADOR_IMOBILIARIO","professionalClassOthers":"string","coverages":[{"coverage":"RESPONSABILIZACAO_CIVIL_VINCULADA_A_PRESTACAO_DE_SERVICOS_PROFISSIONAIS_OBJETO_DA_ATIVIDADE_DO_SEGURADO","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMG":0,"maxLMGDescription":"string","customerServices":"REDE_REFERENCIADA","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","professionalClass":"ADMINISTRADOR_IMOBILIARIO","professionalClassOthers":"string","coverages":[{"coverage":"RESPONSABILIZACAO_CIVIL_VINCULADA_A_PRESTACAO_DE_SERVICOS_PROFISSIONAIS_OBJETO_DA_ATIVIDADE_DO_SEGURADO","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMG":0,"maxLMGDescription":"string","customerServices":"REDE_REFERENCIADA","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","professionalClass":"ADMINISTRADOR_IMOBILIARIO","professionalClassOthers":"string","coverages":[{"coverage":"RESPONSABILIZACAO_CIVIL_VINCULADA_A_PRESTACAO_DE_SERVICOS_PROFISSIONAIS_OBJETO_DA_ATIVIDADE_DO_SEGURADO","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMG":0,"maxLMGDescription":"string","customerServices":"REDE_REFERENCIADA","assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
professionalClass
string
true
none
Classe profissional
professionalClassOthers
string
false
none
Campo aberto para descrição de cada participante ao selecionar o domínio ‘Outros’ no campo acima ‘Classe profissional’
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
Indicação se a cobertura permite contratação separada (por cobertura selecionada).
traits
boolean
true
none
Indicação se o produto é classificado como destinado para cobertura de grandes riscos, sendo tal classificação de acordo com regulamentação específica.
maxLMG
number
true
none
Valor máximo de LMG aceito pela sociedade para o produto.
maxLMGDescription
string
true
none
Descritivo da composição do Limite Máximo de Garantia (LMG) por cobertura
Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
Properties
Name
Type
Required
Restrictions
Description
assistanceServices
boolean
true
none
Indicação se o produto possui serviços de assistências complementares.
assistanceServicesPackage
[any]
false
none
none
complementaryAssistanceServicesDetail
string
false
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
false
none
Indicação se o pacote de assistência é gratuito ou contratado/pago..
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"COBERTURAS_DETALHAMENTO_CONDICOES_ESPECIAIS_E_PARTICULARES","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":[["PESSOA_NATURAL"]]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"COBERTURAS_DETALHAMENTO_CONDICOES_ESPECIAIS_E_PARTICULARES","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":[["PESSOA_NATURAL"]]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"COBERTURAS_DETALHAMENTO_CONDICOES_ESPECIAIS_E_PARTICULARES","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":[["PESSOA_NATURAL"]]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"COBERTURAS_DETALHAMENTO_CONDICOES_ESPECIAIS_E_PARTICULARES","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":[["PESSOA_NATURAL"]]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
false
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.12 do Anexo II
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"GARANTIA_ESTENDIDA_ORIGINAL","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["LINHA_BRANCA"],"securityTypeOthers":"string","assistanceServices":{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"},"customerServices":"REDE_REFERENCIADA","microinsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"GARANTIA_ESTENDIDA_ORIGINAL","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["LINHA_BRANCA"],"securityTypeOthers":"string","assistanceServices":{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"},"customerServices":"REDE_REFERENCIADA","microinsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"GARANTIA_ESTENDIDA_ORIGINAL","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["LINHA_BRANCA"],"securityTypeOthers":"string","assistanceServices":{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"},"customerServices":"REDE_REFERENCIADA","microinsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"GARANTIA_ESTENDIDA_ORIGINAL","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"securityType":["LINHA_BRANCA"],"securityTypeOthers":"string","assistanceServices":{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"string","chargeTypeSignaling":"GRATUITO"},"customerServices":"REDE_REFERENCIADA","microinsurance":true,"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtosss
Indicação se o produto possui serviços de assistências complementares
assistanceServicesPackage
[string]
true
none
Pacotes de Assistência
complementaryAssistanceServicesDetail
string
true
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
true
none
Serviços de Assistências Complementares - Tipo de cobrança
Enumerated Values
Property
Value
chargeTypeSignaling
GRATUITO
chargeTypeSignaling
PAGO
ExtendedWarrantyValidity
[{"term":["ANUAL"],"termOthers":"string"}]
Properties
Name
Type
Required
Restrictions
Description
term
[string]
true
none
none
termOthers
string
false
none
Campo livre para descrição por cada participante ao selecionar o domínio “Outros” no campo Prazo (acima).
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"PROTECAO_DE_BENS","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"PROTECAO_DE_BENS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"PROTECAO_DE_BENS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"PROTECAO_DE_BENS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
false
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.12 do Anexo II
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ALAGAMENTO_E_OU_INUNDACAO","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{},"maxLA":{},"insuredParticipation":[],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMGDescription":"string","maxLMG":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"customerServices":["REDE_REFERENCIADA"],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ALAGAMENTO_E_OU_INUNDACAO","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"maxLA":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","idenizationBasis":"POR_OCORRENCIA","idenizationBasisOthers":"string"},"allowApartPurchase":true}],"traits":true,"maxLMGDescription":"string","maxLMG":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"customerServices":["REDE_REFERENCIADA"],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
Indicação se a cobertura permite contratação separada (por cobertura selecionada).
traits
boolean
true
none
Indicação se o produto é classificado como destinado para cobertura de grandes riscos, sendo tal classificação de acordo com regulamentação específica.
maxLMGDescription
string
true
none
Descritivo da composição do Limite Máximo de Garantia (LMG) por cobertura
Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
Properties
Name
Type
Required
Restrictions
Description
assistanceServices
boolean
true
none
Indicação se o produto possui serviços de assistências complementares.
assistanceServicesPackage
[any]
false
none
none
complementaryAssistanceServicesDetail
string
false
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
false
none
Indicação se o pacote de assistência é gratuito ou contratado/pago..
Enumerated Values
Property
Value
chargeTypeSignaling
GRATUITO
chargeTypeSignaling
PAGO
GeneralLiabilityValidity
[{"term":["ANUAL"],"termOthers":"string"}]
Properties
Name
Type
Required
Restrictions
Description
term
[string]
true
none
none
termOthers
string
false
none
Campo livre para descrição por cada participante ao selecionar o domínio “Outros” no campo Prazo (acima).
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"DANOS_MATERIAIS_CAUSADOS_AO_COFRE_FORTE","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
false
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
{"data":{"brand":{"name":"EMPRESA A seguros","company":[{"name":"ABCDE SEGUROS","cnpjNumber":12345678901234,"products":[{"name":"RESIDENCIAL XPTO","code":"0000-0","coverages":[{"coverageType":"Escritório em Residência","coverageDetail":"Cobertura especial para escritório residenciais","coveragePermissionSeparteAquisition":false,"coverageAttributes":{"minLMI":{},"maxLMI":{},"minDeductibleAmount":{},"insuredMandatoryParticipationPercentage":0}}],"propertyCharacteristics":[{"propertyType":"CASA","propertyBuildType":"ALVENARIA","propertyUsageType":"HABITUAL","destinationInsuredImportance":"PREDIO"}],"propertyZipCode":"1311000","protective":true,"additional":["SORTEIO_GRATUITO"],"additionalOthers":"string","assistanceServices":[{"assistanceServicesPackage":"ATE_10_SERVICOS","complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITA"}],"microInsurance":true,"termsAndConditions":[{"susepProcessNumber":"XXXXX.XXXXXX/XXXX-XX","definition":"https://openinsurance.com.br/aaa"}],"validity":[{"term":"ANUAL","termOthers":"string"}],"customerServices":["LIVRE_ESCOLHA"],"premiumRates":["string"],"premiumPayments":[{"paymentMethod":"CARTAO_CREDITO","paymentMethodDetail":"string","paymentType":"PAGAMENTO_UNICO"}],"minimumRequirements":[{"contractingType":"COLETIVO","contractingMinRequirement":"https://openinsurance.com.br/aaa"}],"targetAudiences":["PESSOA_NATURAL"]}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"string","next":"string","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"EMPRESA A seguros","company":[{"name":"ABCDE SEGUROS","cnpjNumber":12345678901234,"products":[{"name":"RESIDENCIAL XPTO","code":"0000-0","coverages":[{"coverageType":"Escritório em Residência","coverageDetail":"Cobertura especial para escritório residenciais","coveragePermissionSeparteAquisition":false,"coverageAttributes":{"minLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"minDeductibleAmount":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredMandatoryParticipationPercentage":0}}],"propertyCharacteristics":[{"propertyType":"CASA","propertyBuildType":"ALVENARIA","propertyUsageType":"HABITUAL","destinationInsuredImportance":"PREDIO"}],"propertyZipCode":"1311000","protective":true,"additional":["SORTEIO_GRATUITO"],"additionalOthers":"string","assistanceServices":[{"assistanceServicesPackage":"ATE_10_SERVICOS","complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITA"}],"microInsurance":true,"termsAndConditions":[{"susepProcessNumber":"XXXXX.XXXXXX/XXXX-XX","definition":"https://openinsurance.com.br/aaa"}],"validity":[{"term":"ANUAL","termOthers":"string"}],"customerServices":["LIVRE_ESCOLHA"],"premiumRates":["string"],"premiumPayments":[{"paymentMethod":"CARTAO_CREDITO","paymentMethodDetail":"string","paymentType":"PAGAMENTO_UNICO"}],"minimumRequirements":[{"contractingType":"COLETIVO","contractingMinRequirement":"https://openinsurance.com.br/aaa"}],"targetAudiences":["PESSOA_NATURAL"]}]}]}
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"RESIDENCIAL XPTO","code":"0000-0","coverages":[{"coverageType":"Escritório em Residência","coverageDetail":"Cobertura especial para escritório residenciais","coveragePermissionSeparteAquisition":false,"coverageAttributes":{"minLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"minDeductibleAmount":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredMandatoryParticipationPercentage":0}}],"propertyCharacteristics":[{"propertyType":"CASA","propertyBuildType":"ALVENARIA","propertyUsageType":"HABITUAL","destinationInsuredImportance":"PREDIO"}],"propertyZipCode":"1311000","protective":true,"additional":["SORTEIO_GRATUITO"],"additionalOthers":"string","assistanceServices":[{"assistanceServicesPackage":"ATE_10_SERVICOS","complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITA"}],"microInsurance":true,"termsAndConditions":[{"susepProcessNumber":"XXXXX.XXXXXX/XXXX-XX","definition":"https://openinsurance.com.br/aaa"}],"validity":[{"term":"ANUAL","termOthers":"string"}],"customerServices":["LIVRE_ESCOLHA"],"premiumRates":["string"],"premiumPayments":[{"paymentMethod":"CARTAO_CREDITO","paymentMethodDetail":"string","paymentType":"PAGAMENTO_UNICO"}],"minimumRequirements":[{"contractingType":"COLETIVO","contractingMinRequirement":"https://openinsurance.com.br/aaa"}],"targetAudiences":["PESSOA_NATURAL"]}]
Produtos de Seguro Residencial.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
Valor mínimo de franquia e participação obrigatória do segurado - Listagem de valor mínimo da franquia (Reais) e/ou Participação Obrigatória do Segurado (Percentual) estabelecida pela sociedade para cada tipo de cobertura do produto.
insuredMandatoryParticipationPercentage
number
true
none
Listagem percentual de franquia e/ou percentual de participação obrigatória do segurado estabelecida pela sociedade para cada tipo de cobertura de produto.
Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
Properties
Name
Type
Required
Restrictions
Description
assistanceServicesPackage
string
true
none
Pacotes de Assistência.
complementaryAssistanceServicesDetail
string
true
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante.
chargeTypeSignaling
string
true
none
Sinalização em campo exclusivo se o pacote de Assistência é gratuita ou contratada/paga.
Enumerated Values
Property
Value
assistanceServicesPackage
ATE_10_SERVICOS
assistanceServicesPackage
ATE_20_SERVICOS
assistanceServicesPackage
ACIMA_20_SERVICOS
assistanceServicesPackage
CUSTOMIZAVEL
chargeTypeSignaling
GRATUITA
chargeTypeSignaling
PAGO
HomeInsuranceCoverages
[{"coverageType":"Escritório em Residência","coverageDetail":"Cobertura especial para escritório residenciais","coveragePermissionSeparteAquisition":false,"coverageAttributes":{"minLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"minDeductibleAmount":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredMandatoryParticipationPercentage":0}}]
Listagem de coberturas incluídas no produto.
Properties
Name
Type
Required
Restrictions
Description
coverageType
string
true
none
Nome do tipo da cobertura.
coverageDetail
string
true
none
Campo aberto para detalhamento por coberturas possíveis dos produtos a ser feito por cada participante.
coveragePermissionSeparteAquisition
boolean
true
none
Indicação se a cobertura permite contratação separada (por cobertura selecionada).
{"brand":"Brasilprev","societyName":"Brasilprev Seguros e Previdência S.A","cnpjNumber":"27665207000131"}
Organização controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
brand
string
true
none
Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"PERDA_DE_RECEITA_INTERRUPCAO_DE_NEGOCIOS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"microinsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"PERDA_DE_RECEITA_INTERRUPCAO_DE_NEGOCIOS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"microinsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"PERDA_DE_RECEITA_INTERRUPCAO_DE_NEGOCIOS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"microinsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"PERDA_DE_RECEITA_INTERRUPCAO_DE_NEGOCIOS","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"microinsurance":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
false
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.12 do Anexo II
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ALAGAMENTO_INUNDACAO","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ALAGAMENTO_INUNDACAO","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ALAGAMENTO_INUNDACAO","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"ALAGAMENTO_INUNDACAO","coverageDescription":"descrição cobertura","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
false
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.12 do Anexo II
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
{"requestTime":"2021-08-20T08:30:00Z","data":{},"brand":{"name":"EMPRESA","companies":{"name":"EMPRESA Seguros","cnpjNumber":45086338000178,"products":[{"name":"Nome comercial do Produto","code":"123456789_cap","modality":"PENSAO","coverages":[{"coverage":"INVALIDEZ","coveragesAttributes":{"indenizationPaymentMethod":"Pagamento Único","minValue":{"amount":0,"unit":{"code":"string","description":"string"}},"maxValue":{"amount":0,"unit":{"code":"string","description":"string"}},"indemnifiablePeriod":"Prazo","indemnifiableDeadline":48,"currency":"BRL","gracePeriod":{"amount":0,"unit":"DIAS"},"excludedRisk":["ATO_RECONHECIMENTO_PERIGOSO"],"excludedRiskURL":"string"},"coveragePeriod":"Vitalícia"}],"additional":"SORTEIO","additionalOthers":"string","assistanceType":["Funeral"],"assistanceTypeOthers":["string"],"termAndCondition":[{"susepProcessNumber":"15414.622222/2222-22","definition":"wwww.seguradora.com.br/termos"}],"updatePMBaC":{"interestRate":14,"updateIndex":"IPCA(IBGE)"},"premiumUpdateIndex":"IPCA","ageReframing":{"reframingCriterion":"Após período em anos","reframingPeriodicity":10},"financialRegimeContractType":"Repartição Simples","reclaim":{"reclaimTable":[{"initialMonthRange":0,"finalMonthRange":0,"percentage":"string"}],"differentiatedPercentage":"string","gracePeriod":"20/Não se aplica"},"otherGuarateedValues":"Saldamento","profitModality":"PAGAMENTO_UNICO","contributionPayment":{"contributionPaymentMethod":["Cartão de crédito"],"contributionPeriodicity":["Mensal"]},"contributionTax":"string","minimumRequirements":{"minRequirementsContractType":"Individual","minRequirementsContract":"wwww.seguradora.com.br/termos"},"targetAudience":"Pessoa Natural"}]}},"linksPaginated":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"string","next":"string","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"metaPaginated":{"totalRecords":10,"totalPages":1}}
Properties
Name
Type
Required
Restrictions
Description
requestTime
string(date-time)
false
none
Data e hora da consulta, conforme especificação RFC-3339, formato UTC.
{"name":"EMPRESA","companies":{"name":"EMPRESA Seguros","cnpjNumber":45086338000178,"products":[{"name":"Nome comercial do Produto","code":"123456789_cap","modality":"PENSAO","coverages":[{"coverage":"INVALIDEZ","coveragesAttributes":{"indenizationPaymentMethod":"Pagamento Único","minValue":{"amount":0,"unit":{"code":"string","description":"string"}},"maxValue":{"amount":0,"unit":{"code":"string","description":"string"}},"indemnifiablePeriod":"Prazo","indemnifiableDeadline":48,"currency":"BRL","gracePeriod":{"amount":0,"unit":"DIAS"},"excludedRisk":["ATO_RECONHECIMENTO_PERIGOSO"],"excludedRiskURL":"string"},"coveragePeriod":"Vitalícia"}],"additional":"SORTEIO","additionalOthers":"string","assistanceType":["Funeral"],"assistanceTypeOthers":["string"],"termAndCondition":[{"susepProcessNumber":"15414.622222/2222-22","definition":"wwww.seguradora.com.br/termos"}],"updatePMBaC":{"interestRate":14,"updateIndex":"IPCA(IBGE)"},"premiumUpdateIndex":"IPCA","ageReframing":{"reframingCriterion":"Após período em anos","reframingPeriodicity":10},"financialRegimeContractType":"Repartição Simples","reclaim":{"reclaimTable":[{"initialMonthRange":0,"finalMonthRange":0,"percentage":"string"}],"differentiatedPercentage":"string","gracePeriod":"20/Não se aplica"},"otherGuarateedValues":"Saldamento","profitModality":"PAGAMENTO_UNICO","contributionPayment":{"contributionPaymentMethod":["Cartão de crédito"],"contributionPeriodicity":["Mensal"]},"contributionTax":"string","minimumRequirements":{"minRequirementsContractType":"Individual","minRequirementsContract":"wwww.seguradora.com.br/termos"},"targetAudience":"Pessoa Natural"}]}}
Organização controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
Informações referente a sociedade a qual a marca pertence.
PensionPlanCompany
{"name":"EMPRESA Seguros","cnpjNumber":45086338000178,"products":[{"name":"Nome comercial do Produto","code":"123456789_cap","modality":"PENSAO","coverages":[{"coverage":"INVALIDEZ","coveragesAttributes":{"indenizationPaymentMethod":"Pagamento Único","minValue":{"amount":0,"unit":{"code":"string","description":"string"}},"maxValue":{"amount":0,"unit":{"code":"string","description":"string"}},"indemnifiablePeriod":"Prazo","indemnifiableDeadline":48,"currency":"BRL","gracePeriod":{"amount":0,"unit":"DIAS"},"excludedRisk":["ATO_RECONHECIMENTO_PERIGOSO"],"excludedRiskURL":"string"},"coveragePeriod":"Vitalícia"}],"additional":"SORTEIO","additionalOthers":"string","assistanceType":["Funeral"],"assistanceTypeOthers":["string"],"termAndCondition":[{"susepProcessNumber":"15414.622222/2222-22","definition":"wwww.seguradora.com.br/termos"}],"updatePMBaC":{"interestRate":14,"updateIndex":"IPCA(IBGE)"},"premiumUpdateIndex":"IPCA","ageReframing":{"reframingCriterion":"Após período em anos","reframingPeriodicity":10},"financialRegimeContractType":"Repartição Simples","reclaim":{"reclaimTable":[{"initialMonthRange":0,"finalMonthRange":0,"percentage":"string"}],"differentiatedPercentage":"string","gracePeriod":"20/Não se aplica"},"otherGuarateedValues":"Saldamento","profitModality":"PAGAMENTO_UNICO","contributionPayment":{"contributionPaymentMethod":["Cartão de crédito"],"contributionPeriodicity":["Mensal"]},"contributionTax":"string","minimumRequirements":{"minRequirementsContractType":"Individual","minRequirementsContract":"wwww.seguradora.com.br/termos"},"targetAudience":"Pessoa Natural"}]}
Informações referente a sociedade a qual a marca pertence.
[{"name":"Nome comercial do Produto","code":"123456789_cap","modality":"PENSAO","coverages":[{"coverage":"INVALIDEZ","coveragesAttributes":{"indenizationPaymentMethod":"Pagamento Único","minValue":{"amount":0,"unit":{"code":"string","description":"string"}},"maxValue":{"amount":0,"unit":{"code":"string","description":"string"}},"indemnifiablePeriod":"Prazo","indemnifiableDeadline":48,"currency":"BRL","gracePeriod":{"amount":0,"unit":"DIAS"},"excludedRisk":["ATO_RECONHECIMENTO_PERIGOSO"],"excludedRiskURL":"string"},"coveragePeriod":"Vitalícia"}],"additional":"SORTEIO","additionalOthers":"string","assistanceType":["Funeral"],"assistanceTypeOthers":["string"],"termAndCondition":[{"susepProcessNumber":"15414.622222/2222-22","definition":"wwww.seguradora.com.br/termos"}],"updatePMBaC":{"interestRate":14,"updateIndex":"IPCA(IBGE)"},"premiumUpdateIndex":"IPCA","ageReframing":{"reframingCriterion":"Após período em anos","reframingPeriodicity":10},"financialRegimeContractType":"Repartição Simples","reclaim":{"reclaimTable":[{"initialMonthRange":0,"finalMonthRange":0,"percentage":"string"}],"differentiatedPercentage":"string","gracePeriod":"20/Não se aplica"},"otherGuarateedValues":"Saldamento","profitModality":"PAGAMENTO_UNICO","contributionPayment":{"contributionPaymentMethod":["Cartão de crédito"],"contributionPeriodicity":["Mensal"]},"contributionTax":"string","minimumRequirements":{"minRequirementsContractType":"Individual","minRequirementsContract":"wwww.seguradora.com.br/termos"},"targetAudience":"Pessoa Natural"}]
Produtos de Seguro de Automóveis.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
modality
string
true
none
Lista padronizada de modalidades de coberturas incluídas no produto.
{"reframingCriterion":"Após período em anos","reframingPeriodicity":10}
Reenquadramento etário.
Properties
Name
Type
Required
Restrictions
Description
reframingCriterion
string
true
none
Critério para reenquadramento etário.
reframingPeriodicity
integer
true
none
Período em anos para reenquadramento etário.
Enumerated Values
Property
Value
reframingCriterion
APOS_PERIODO_ANOS
reframingCriterion
CADA_PERIODO_ANOS
reframingCriterion
MUDANCA_FAIXA_ETARIA
reframingCriterion
NAO_APLICAVEL
PensionPlanReclaim
{"reclaimTable":[{"initialMonthRange":0,"finalMonthRange":0,"percentage":"string"}],"differentiatedPercentage":"string","gracePeriod":"20/Não se aplica"}
Nome da marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa das sociedades sob ela em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
Listagem dos serviços de assistências complementares disponíveis vinculados ao produto. Deve ser padronizada na proposta técnica submetida pela Estrutura Inicial de Governança para observância comum por todas as sociedades participantes
Seguro de pessoas com capital global modalidade de contratação coletiva da cobertura de risco, respeitados os critérios técnico-operacionais, forma e limites fixados pela SUSEP, segundo a qual o valor do capital segurado referente a cada componente sofrerá variações decorrentes de mudanças na composição do grupo segurado
Listagem do valor mínimo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto. Em reais
Listagem do valor máximo de cobertura (Capital Segurado), diária ou parcela aceito pela sociedade para cada combinação de modalidade/cobertura do produto. Em reais
indemnifiablePeriod
[string]
true
none
Listagem de período indenizável para cada combinação de modalidade/cobertura do produto
maximumQtyIndemnifiableInstallments
integer
true
none
Caso o período indenizável seja relacionado a parcelas, listagem de número máximo de parcelas indenizáveis para cada combinação de modalidade/ cobertura do produto
currency
string
true
none
Moeda sobre a qual a cobertura se refere. De acordo com ISO-4217.
Detalhamento do período de carência diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo
deductibleDays
integer
true
none
Listagem de franquia em dias para cada combinação de modalidade/cobertura do produto.
differentiatedDeductibleDays
number
false
none
Detalhamento da franquia em dias diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.
deductibleBRL
number
true
none
Listagem de franquia em reais para cada combinação de modalidade/cobertura do produto.
differentiatedDeductibleBRL
string
false
none
Detalhamento da franquia em reais diferentes para cada cobertura que exista alguma especificidade. Caso a seguradora não tenha essa diferenciação, não retornará nada no campo.
excludedRisks
[string]
true
none
Listagem dos tipos de riscos excluídos para cada combinação de modalidade/cobertura do produto. Deve ser padronizada na proposta técnica submetida pela Estrutura Inicial de Governança para observância comum por todas as sociedades participantes
excludedRisksURL
string
false
none
Campo aberto (possibilidade de incluir URL).
allowApartPurchase
boolean
true
none
Indicar se a cobertura pode ser contratada isoladamente ou não.
Listagem de percentuais de resgate da PMBaC para cada conjunto de prazo aplicável e para cada combinação de modalidade/cobertura estruturados em regime de capitalização
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"CONSTRUCAO_OBRAS","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"CONSTRUCAO_OBRAS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"CONSTRUCAO_OBRAS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"CONSTRUCAO_OBRAS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Nome Cobertura Contratatada - Básica
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"LICITANTE","coverageDescription":"string","coverageAttributes":{"maxLMI":{},"insuredParticipation":[],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":"A_VISTA","premiumRates":["string"]}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"LICITANTE","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":"A_VISTA","premiumRates":["string"]}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"LICITANTE","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":"A_VISTA","premiumRates":["string"]}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"LICITANTE","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}},"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string"},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":"A_VISTA","premiumRates":["string"]}],"termsAndConditions":{"susepProcessNumber":15414622222222222,"definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"https://openinsurance.com.br/aaa","targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"NAO_PAGAMENTO_DE_13_ALUGUEL","coverageDescription":"string","coverageAttributes":{"insuredParticipation":[],"insuredParticipationDescription":"string","maxLMI":"string"},"allowApartPurchase":true}],"traits":true,"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"customerServices":["LIVRE ESCOLHA"],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"NAO_PAGAMENTO_DE_13_ALUGUEL","coverageDescription":"string","coverageAttributes":{"insuredParticipation":["FRANQUIA"],"insuredParticipationDescription":"string","maxLMI":"string"},"allowApartPurchase":true}],"traits":true,"assistanceServices":[{"assistanceServices":true,"assistanceServicesPackage":["ATE_10_SERVICOS"],"complementaryAssistanceServicesDetail":"reboque pane seca","chargeTypeSignaling":"GRATUITO"}],"customerServices":["LIVRE ESCOLHA"],"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumPayment":[{"paymentMethod":"CARTAO_DE_CREDITO","paymentDetail":"string","paymentType":["A_VISTA"],"premiumRates":"string"}],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"contractType":["COLETIVO"],"minimumRequirementDetails":"string","targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
Agrupamento dos serviços de assistências disponíveis vinculado ao produto.
Properties
Name
Type
Required
Restrictions
Description
assistanceServices
boolean
true
none
Indicação se o produto possui serviços de assistências complementares.
assistanceServicesPackage
[any]
false
none
none
complementaryAssistanceServicesDetail
string
false
none
Campo livre para descrição dos serviços ofertados por cada sociedade participante, contendo minimamente cada um dos serviços assistenciais complementares oferecidos e se o pacote se trata de uma cobertura de assistência securitária ou se serviços de assistência
chargeTypeSignaling
string
false
none
Indicação se o pacote de assistência é gratuito ou contratado/pago.
{"data":{"brand":{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"STOP_LOSS","coverageDescription":"string","coverageAttributes":{"maxLMI":{}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/products-services/v1","first":"https://api.organizacao.com.br/open-insurance/products-services/v1","prev":"https://api.organizacao.com.br/open-insurance/products-services/v1","next":"https://api.organizacao.com.br/open-insurance/products-services/v1","last":"https://api.organizacao.com.br/open-insurance/products-services/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"name":"ACME Group Seguros","companies":[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"STOP_LOSS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]}
Organizacao controladora do grupo.
Properties
Name
Type
Required
Restrictions
Description
name
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes.
[{"name":"ACME Seguros","cnpjNumber":"12345678901234","products":[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"STOP_LOSS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]}]
[{"name":"Produto de Seguro","code":"01234589-0","coverages":[{"coverage":"STOP_LOSS","coverageDescription":"string","coverageAttributes":{"maxLMI":{"amount":0,"unit":{"code":"R$","description":"REAL"}}},"allowApartPurchase":true}],"traits":true,"validity":[{"term":["ANUAL"],"termOthers":"string"}],"premiumRates":["string"],"termsAndConditions":{"susepProcessNumber":"15414.622222/2222-22","definition":"https://www.seguradora.com.br/produto/tradicional/pdf/condicoes_gerais.pdf"},"minimumRequirements":{"targetAudiences":["PESSOA_NATURAL"]}}]
Lista de produtos de uma empresa.
Properties
Name
Type
Required
Restrictions
Description
name
string
false
none
Nome comercial do produto, pelo qual é identificado nos canais de distribuição e atendimento da sociedade.
code
string
true
none
Código único a ser definido pela sociedade.
coverages
[object]
true
none
none
» coverage
string
true
none
Listagem de coberturas incluídas no produto que deve observar a relação discriminada de coberturas, conforme Tabela II.12 do Anexo II
» coverageDescription
string
true
none
Campo aberto para detalhamento de cada uma das coberturas possíveis dos produtos
Clientes poderão solicitar o compartilhamento entre instituições participantes de seus dados cadastrais, de informações sobre dados pessoais de seguro, previdência complementar aberta e capitalização.
O compartilhamento ocorre apenas se a pessoa autorizar através da API de Consentimento, sempre para finalidades determinadas e por um prazo específico. E será possível para o cliente cancelar essa autorização a qualquer momento em qualquer uma das instituições envolvidas no compartilhamento.
API - Consents v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
API que trata da criação, consulta e revogação de consentimentos para o Open Insurance Brasil Fase 2 - customer-data.
Não possui segregação entre pessoa natural e pessoa jurídica.
Orientações importantes
A API Consents trata dos consentimentos exclusivamente para a fase 2 do Open Insurance Brasil.
- As informações da instituição receptora não trafegam na API Consents – a autenticação da receptora se dá através do DCR.
Na chamada para a criação do consentimento deve-se utilizar um token gerado via client_credentials.
Após o POST de criação do consentimento, o STATUS devolvido na resposta deverá ser AWAITING_AUTHORISATION.
O STATUS será alterado para AUTHORISED somente após autenticação e confirmação por parte do usuário na instituição transmissora dos dados.
Todas as datas trafegadas nesta API seguem o padrão da RFC3339 e formato "zulu".
A receptora deve enviar obrigatoriamente, no pedido de criação de consentimento, todas as permissions dos agrupamentos de dados as quais ela deseja consentimento, conforme tabela abaixo:
A instituição transmissora deve validar o preenchimento correto desses agrupamentos no momento da geração do consentimento.
Caso a instiuição receptora envie permissões divergentes ao agrupamento especificado na tabela, a transmissora deve rejeitar o pedido da receptora dando retorno HTTP Status Code 400.
A transmissora deve retornar, da lista de permissions requisitadas, apenas o subconjunto de permissions por ela suportada, removendo da lista as permissions de produtos não suportados e retornando HTTP Status Code 201. Caso não restem permissões funcionais, a instituição transmissora deve retornar o erro HTTP Code "422 Unprocessable Entity".
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
API que trata da consulta do status de recursos para o Open Insurance Brasil - Fase 2.
Não possui segregação entre pessoa natural e pessoa jurídica.
Orientações importantes
A API resources lista os recursos vinculados ao consentimento específico, identificado por consentId e vinculado ao token enviado no header Authorization.
Os STATUS dos recursos listados DEVEM considerar não apenas o consentimento vinculado mas também a disponibilidade do recurso na instituição transmissora dos dados.
Na lista de recursos devolvida na API resources somente constará informação no atributo resourceId para recursos com o STATUSAVAILABLE.
Para os demais STATUS não é devolvido o identificador do recurso - resourceId.
A permission específica desta API - RESOURCES_READ - DEVE ser solicitada pela instituição receptora na ocasião do pedido de criação do consentimento.
A consulta à API Resources não é obrigatória por parte das instituições receptoras - esta API foi criada para dar visibilidade da existência de ocorrências que possam impedir o compartilhamento de determinados recursos por parte da instituição transmissora dos dados.
O identificador do recurso devolvido na API Resources - resourceId - quando apresentado corresponde ao mesmo identificador designado para o recurso em sua API específica.
Status previstos para os recursos listados na API Resources
AVAILABLE: indica que o recurso encontra-se disponível e o(s) consentimento(s) associado(s) possui(em) status AUTHORISED.
UNAVAILABLE: indica que o recurso não está mais disponível.
TEMPORARILY_UNAVAILABLE: indica que o recurso encontra-se temporariamente indisponível, embora o(s) consentimento(s) associado(s) possua(m) status AUTHORISED.
PENDING_AUTHORISATION: indica a existência de pendências para o compartilhamento do recurso, por exemplo, em caso de alçada dupla, quando é necessário o consentimento de mais de um titular.
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Requer o processo de redirecionamento e autenticação do usuário a que se referem os dados.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
API de dados cadastrais de clientes do Open Insurance Brasil – Fase 2.
API que retorna os dados cadastrais de clientes e de seus representantes, incluindo dados de identificação, de qualificação, informações sobre representantes cadastrados e sobre o relacionamento do cliente com a instituição transmissora dos dados.
Possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os endpoints.
Orientações
A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao consentId específico relacionado.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado (consentId).
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.
Permissions necessárias para a API Customers
Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Requer o processo de redirecionamento e autenticação do usuário a que se referem os dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes.
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
API de Aceitação e Sucursal no exterior do Open Insurance Brasil - Fase 2.
Traz informações de apólice, prêmio e sinistro mantidas nas instituições transmissoras por seus clientes.
Não possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os 'endpoints'.
Orientações
A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (identificado pelo consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao consentId específico.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc.) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso, as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado.
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.
Permissions necessárias para a API InsuranceAcceptanceAndBranchesAbroad
Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Método para obter as informações gerais da apólice
Parameters
Name
In
Type
Required
Description
Authorization
header
string
true
Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado.
x-fapi-auth-date
header
string
false
Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a RFC7231. Exemplo: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
header
string
false
O endereço IP do usuário se estiver atualmente logado com o receptor.
x-fapi-interaction-id
header
string
false
Um UID RFC4122 usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
x-customer-user-agent
header
string
false
Indica o user-agent que o usuário utiliza.
policyId
path
string
true
none
Example responses
200 Response
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"OUTRAS","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"OUTRAS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"riskCountry":"BRA","hasForum":true,"forumDescription":"string","transferorId":"12345678912","transferorName":"Nome Sobrenome","groupBranches":[111]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-acceptance-and-branches-abroad/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-acceptance-and-branches-abroad/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-acceptance-and-branches-abroad/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-acceptance-and-branches-abroad/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-acceptance-and-branches-abroad/v1"},"meta":{"totalRecords":10,"totalPages":1}}
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
API de Automóvel do Open Insurance Brasil - Fase 2.
Traz informações de apólice, prêmio e sinistro mantidas nas instituições transmissoras por seus clientes.
Não possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os 'endpoints'.
Orientações
A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (identificado pelo consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao consentId específico.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc.) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso, as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado.
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.
Permissions necessárias para a API InsuranceAuto
Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Método para obter as informações gerais da apólice
Parameters
Name
In
Type
Required
Description
Authorization
header
string
true
Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado.
x-fapi-auth-date
header
string
false
Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a RFC7231. Exemplo: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
header
string
false
O endereço IP do usuário se estiver atualmente logado com o receptor.
x-fapi-interaction-id
header
string
false
Um UID RFC4122 usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
x-customer-user-agent
header
string
false
Indica o user-agent que o usuário utiliza.
policyId
path
string
true
none
Example responses
200 Response
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","hasExactVehicleIdentification":true,"modality":"VALOR_DE_MERCADO_REFERENCIADO","amountReferenceTable":"MOLICAR","model":"string","year":"stri","fareCategory":"10","riskPostCode":"10000000","vehicleUsage":"LAZER","frequentDestinationPostCode":"10000000","overnightPostCode":"10000000","coverages":[{"branch":111,"code":"CASCO_COMPREENSIVA","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD","adjustmentRate":10,"premiumAmount":{"amount":2000,"currency":"BRL"},"compensationType":"PARCIAL","partialCompensationPercentage":10,"percentageOverLMI":10,"daysForTotalCompensation":0,"boundCoverage":"VEICULO"}]}],"coverages":[{"branch":111,"code":"CASCO_COMPREENSIVA","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo","hasDeductibleOverTotalCompensation":true},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"repairNetwork":"REDE_REFERENCIADA","repairedPartsUsageType":"NOVA_E_USADA","repairedPartsClassification":"ORIGINAL_E_COMPATIVEL","repairedPartsNationality":"NACIONAL_E_IMPORTADA","validityType":"SEMESTRAL_INTERMITENTE","otherCompensations":"string","otherBenefits":"DESCONTOS","assistancePackages":"ATE_DEZ_SERVICOS","isExpiredRiskPolicy":true,"bonusDiscountRate":0,"bonusClass":"string","drivers":[{"identification":"12345678900","sex":"MASCULINO","birthDate":"AAAA-MM-DD","licensedExperience":4}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-auto/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-auto/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-auto/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-auto/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-auto/v1"},"meta":{"totalRecords":10,"totalPages":1}}
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
API de Aeronáuticos do Open Insurance Brasil - Fase 2.
Traz informações de apólice, prêmio e sinistro mantidas nas instituições transmissoras por seus clientes.
Não possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os 'endpoints'.
Orientações
A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (identificado pelo consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao consentId específico.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc.) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso, as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado.
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.
Permissions necessárias para a API Insurance Aviation
Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Método para obter as informações gerais da apólice
Parameters
Name
In
Type
Required
Description
Authorization
header
string
true
Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado.
x-fapi-auth-date
header
string
false
Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a RFC7231. Exemplo: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
header
string
false
O endereço IP do usuário se estiver atualmente logado com o receptor.
x-fapi-interaction-id
header
string
false
Um UID RFC4122 usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
x-customer-user-agent
header
string
false
Indica o user-agent que o usuário utiliza.
policyId
path
string
true
none
Example responses
200 Response
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"CASCO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"CASCO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-aviation/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-aviation/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-aviation/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-aviation/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-aviation/v1"},"meta":{"totalRecords":10,"totalPages":1}}
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
API de Riscos Financeiros do Open Insurance Brasil - Fase 2.
Traz informações de apólice, prêmio e sinistro mantidas nas instituições transmissoras por seus clientes.
Não possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os 'endpoints'.
Orientações
A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (identificado pelo consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao consentId específico.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc.) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso, as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado.
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.
Permissions necessárias para a API InsuranceFinancialRisk
Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Método para obter as informações gerais da apólice
Parameters
Name
In
Type
Required
Description
Authorization
header
string
true
Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado.
x-fapi-auth-date
header
string
false
Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a RFC7231. Exemplo: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
header
string
false
O endereço IP do usuário se estiver atualmente logado com o receptor.
x-fapi-interaction-id
header
string
false
Um UID RFC4122 usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
x-customer-user-agent
header
string
false
Indica o user-agent que o usuário utiliza.
policyId
path
string
true
none
Example responses
200 Response
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"PROTECAO_DE_BENS","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"PROTECAO_DE_BENS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"userGroup":"string","technicalSurplus":10}},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-financial-risk/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-financial-risk/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-financial-risk/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-financial-risk/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-financial-risk/v1"},"meta":{"totalRecords":10,"totalPages":1}}
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Traz informações de apólice, prêmio e sinistro mantidas nas instituições transmissoras por seus clientes.
Não possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os 'endpoints'.
Orientações
A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (identificado pelo consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao consentId específico.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc.) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso, as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado.
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.
Permissions necessárias para a API InsuranceNautical
Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Método para obter as informações gerais da apólice
Parameters
Name
In
Type
Required
Description
Authorization
header
string
true
Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado.
x-fapi-auth-date
header
string
false
Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a RFC7231. Exemplo: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
header
string
false
O endereço IP do usuário se estiver atualmente logado com o receptor.
x-fapi-interaction-id
header
string
false
Um UID RFC4122 usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
x-customer-user-agent
header
string
false
Indica o user-agent que o usuário utiliza.
policyId
path
string
true
none
Example responses
200 Response
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"BASICA","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"BASICA","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-nautical/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-nautical/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-nautical/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-nautical/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-nautical/v1"},"meta":{"totalRecords":10,"totalPages":1}}
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Traz informações de apólice, prêmio e sinistro mantidas nas instituições transmissoras por seus clientes.
Não possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os 'endpoints'.
Orientações
A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (identificado pelo consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao consentId específico.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc.) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso, as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado.
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.
Permissions necessárias para a API InsuranceNuclear
Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Método para obter as informações gerais da apólice
Parameters
Name
In
Type
Required
Description
Authorization
header
string
true
Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado.
x-fapi-auth-date
header
string
false
Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a RFC7231. Exemplo: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
header
string
false
O endereço IP do usuário se estiver atualmente logado com o receptor.
x-fapi-interaction-id
header
string
false
Um UID RFC4122 usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
x-customer-user-agent
header
string
false
Indica o user-agent que o usuário utiliza.
policyId
path
string
true
none
Example responses
200 Response
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"RISCOS_NUCLEARES","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"RISCOS_NUCLEARES","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-nuclear/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-nuclear/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-nuclear/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-nuclear/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-nuclear/v1"},"meta":{"totalRecords":10,"totalPages":1}}
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
API de Patrimonial do Open Insurance Brasil - Fase 2.
Traz informações de apólice, prêmio e sinistro mantidas nas instituições transmissoras por seus clientes.
Não possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os 'endpoints'.
Orientações
A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (identificado pelo consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao consentId específico.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc.) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso, as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado.
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.
Permissions necessárias para a API InsurancePatrimonial
Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Método para obter as informações gerais da apólice
Parameters
Name
In
Type
Required
Description
Authorization
header
string
true
Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado.
x-fapi-auth-date
header
string
false
Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a RFC7231. Exemplo: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
header
string
false
O endereço IP do usuário se estiver atualmente logado com o receptor.
x-fapi-interaction-id
header
string
false
Um UID RFC4122 usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
x-customer-user-agent
header
string
false
Indica o user-agent que o usuário utiliza.
policyId
path
string
true
none
Example responses
200 Response
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"LUCRO_BRUTO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"LUCRO_BRUTO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"basicCoverageIndex":"SIMPLES","insuredObjects":[{"identification":"string","propertyType":"CASA","structuringType":"CONDOMINIO_VERTICAL","postCode":"10000000","businessActivity":"1234567"}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-patrimonial/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-patrimonial/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-patrimonial/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-patrimonial/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-patrimonial/v1"},"meta":{"totalRecords":10,"totalPages":1}}
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
API de Petróleo do Open Insurance Brasil - Fase 2.
Traz informações de apólice, prêmio e sinistro mantidas nas instituições transmissoras por seus clientes.
Não possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os 'endpoints'.
Orientações
A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (identificado pelo consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao consentId específico.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc.) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso, as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado.
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.
Permissions necessárias para a API Insurance Petroleum
Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Método para obter as informações gerais da apólice
Parameters
Name
In
Type
Required
Description
Authorization
header
string
true
Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado.
x-fapi-auth-date
header
string
false
Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a RFC7231. Exemplo: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
header
string
false
O endereço IP do usuário se estiver atualmente logado com o receptor.
x-fapi-interaction-id
header
string
false
Um UID RFC4122 usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
x-customer-user-agent
header
string
false
Indica o user-agent que o usuário utiliza.
policyId
path
string
true
none
Example responses
200 Response
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"RISCOS_DE_PETROLEO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"RISCOS_DE_PETROLEO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-petroleum/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-petroleum/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-petroleum/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-petroleum/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-petroleum/v1"},"meta":{"totalRecords":10,"totalPages":1}}
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
API de Responsabilidade do Open Insurance Brasil - Fase 2.
Traz informações de apólice, prêmio e sinistro mantidas nas instituições transmissoras por seus clientes.
Não possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os 'endpoints'.
Orientações
A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (identificado pelo consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao consentId específico.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc.) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso, as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado.
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.
Permissions necessárias para a API InsuranceResponsibility
Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Método para obter as informações gerais da apólice
Parameters
Name
In
Type
Required
Description
Authorization
header
string
true
Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado.
x-fapi-auth-date
header
string
false
Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a RFC7231. Exemplo: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
header
string
false
O endereço IP do usuário se estiver atualmente logado com o receptor.
x-fapi-interaction-id
header
string
false
Um UID RFC4122 usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
x-customer-user-agent
header
string
false
Indica o user-agent que o usuário utiliza.
policyId
path
string
true
none
Example responses
200 Response
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"DANOS_CAUSADOS_A_TERCEIROS","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"DANOS_CAUSADOS_A_TERCEIROS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"coverages":[{"branch":111,"code":"DANOS_CAUSADOS_A_TERCEIROS","description":"string","type":"POR_OCORRENCIA","typeDescription":"string","retroactivityDate":"AAAA-MM-DD","retroactivityPeriod":"string","retroactivityTimeUnit":"DIA","retroactivityWorkingDaysIndex":"DIAS_UTEIS","complementaryTermStartDate":"AAAA-MM-DD","complementaryTermEndDate":"AAAA-MM-DD","complementaryTerm":"string","complementaryTermTimeUnit":"DIA","complementaryTermWorkingDaysIndex":"DIAS_UTEIS","supplementaryTermStartDate":"AAAA-MM-DD","supplementaryTermEndDate":"AAAA-MM-DD","supplementaryTerm":"string","supplementaryTermTimeUnit":"DIA","supplementaryTermWorkingDaysIndex":"DIAS_UTEIS","lawyerRecommendation":"ESCOLHIDO_PELO_SEGURADO","lawyerRecommendationDescription":"string"}],"insuredObjects":[{"identification":"string","hasComplementaryContract":true,"complementaryContractAmount":{"amount":2000,"currency":"BRL"},"coveragesMaxAmount":{"amount":2000,"currency":"BRL"},"coveragesTermStartDate":"AAAA-MM-DD","coveragesTermEndDate":"AAAA-MM-DD","coveragesTerm":100,"coveragesUnit":"DIA","coveragesWorkingDaysIndex":"DIAS_UTEIS","hasTransportationPollutionDamage":true,"hasThirdPatyDamage":true,"professionalClass":"ADMINISTRADOR_IMOBILIARIO","hasRetroactivityApplication":true}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-responsibility/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-responsibility/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-responsibility/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-responsibility/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-responsibility/v1"},"meta":{"totalRecords":10,"totalPages":1}}
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Traz informações de apólice, prêmio e sinistro mantidas nas instituições transmissoras por seus clientes.
Não possui segregação entre pessoa natural e pessoa jurídica.
Requer consentimento do cliente para todos os 'endpoints'.
Orientações
A Role do diretório de participantes relacionada à presente API é a DADOS.
Para todos os endpoints desta API é previsto o envio de um token através do header Authorization.
Este token deverá estar relacionado ao consentimento (identificado pelo consentId) mantido na instituição transmissora dos dados, o qual permitirá a pesquisa e retorno, na API em questão, dos
dados relacionados ao consentId específico.
Os dados serão devolvidos na consulta desde que o consentId relacionado corresponda a um consentimento válido e com o status AUTHORISED.
É também necessário que o recurso em questão (conta, contrato, etc.) esteja disponível na instituição transmissora (ou seja, sem boqueios de qualquer natureza e com todas as autorizações/consentimentos já autorizados).
Além disso, as permissions necessárias deverão ter sido solicitadas quando da criação do consentimento relacionado.
Relacionamos a seguir as permissions necessárias para a consulta de dados em cada endpoint da presente API.
Permissions necessárias para a API Insurance Rural
Para cada um dos paths desta API, além dos escopos (scopes) indicados existem permissions que deverão ser observadas:
oAuth2 authentication. Fluxo OAuth necessário para que a receptora tenha acesso aos dados na instituição transmissora. Inclui o processo de redirecionamento e autenticação do usuário a que se referem os dados.
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Método para obter as informações gerais da apólice
Parameters
Name
In
Type
Required
Description
Authorization
header
string
true
Cabeçalho HTTP padrão. Permite que as credenciais sejam fornecidas dependendo do tipo de recurso solicitado.
x-fapi-auth-date
header
string
false
Data em que o usuário logou pela última vez com o receptor. Representada de acordo com a RFC7231. Exemplo: Sun, 10 Sep 2017 19:43:31 UTC
x-fapi-customer-ip-address
header
string
false
O endereço IP do usuário se estiver atualmente logado com o receptor.
x-fapi-interaction-id
header
string
false
Um UID RFC4122 usado como um ID de correlação. Se fornecido, o transmissor deve "reproduzir" esse valor no cabeçalho de resposta.
x-customer-user-agent
header
string
false
Indica o user-agent que o usuário utiliza.
policyId
path
string
true
none
Example responses
200 Response
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"GRANIZO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"GRANIZO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"insuredObjects":[{"identification":"string","isFESRParticipant":true,"subventionAmount":{"amount":2000,"currency":"BRL"},"subventionType":"AC","safeArea":2000,"unitMeasure":"HECTAR","cultureCode":11111111,"flockCode":"BOVINOS","forestCode":"PINUS","surveyDate":"AAAA-MM-DD","surveyAddress":"string","surveyCountrySubDivision":"SP","surveyPostCode":10000000,"surveyCountryCode":"BRA","surveyorIdType":"CPF","surveyorId":40,"surveyorName":"string","modelType":"CLIMATICOS","areAssetsCovered":true,"coveredAnimalDestination":"CONSUMO","animalType":"ELITE"}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-rural/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-rural/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-rural/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-rural/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-rural/v1"},"meta":{"totalRecords":10,"totalPages":1}}
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
O servidor entende o tipo de conteúdo da entidade da requisição, e a sintaxe da requisição esta correta, mas não foi possível processar as instruções presentes
A operação foi recusada, pois muitas solicitações foram feitas dentro de um determinado período ou o limite global de requisições concorrentes foi atingido
Titular, pessoa jurídica a quem se referem os dados que são objeto de compartilhamento.
» permissions
[string]
true
none
none
» expirationDateTime
string(date-time)
true
none
Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
» transactionFromDateTime
string(date-time)
false
none
Data e hora da transação inicial. Se não for preenchido, a transação terá a data aberta e a data será retornada com a primeira transação disponível. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
» transactionToDateTime
string(date-time)
false
none
Data e hora final da transação. Se não for preenchido, a transação terá a data aberta e a data será retornada com a ultima transação disponível. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
O consentId é o identificador único do consentimento e deverá ser um URN - Uniform Resource Name. Um URN, conforme definido na RFC8141 é um Uniform Resource Identifier - URI - que é atribuído sob o URI scheme "urn" e um namespace URN específico, com a intenção de que o URN seja um identificador de recurso persistente e independente da localização. Considerando a string urn:prudential:C1DD93123 como exemplo para consentId temos: - o namespace(urn) - o identificador associado ao namespace da instituição transnmissora (prudential) - o identificador específico dentro do namespace (C1DD93123). Informações mais detalhadas sobre a construção de namespaces devem ser consultadas na RFC8141.
» creationDateTime
string(date-time)
true
none
Data e hora em que o recurso foi criado. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
» status
string
true
none
Estado atual do consentimento cadastrado.
» statusUpdateDateTime
string(date-time)
true
none
Data e hora em que o recurso foi atualizado. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
» permissions
[string]
true
none
Especifica os tipos de permissões de acesso às APIs no escopo do Open Insurance Brasil - Fase 2, de acordo com os blocos de consentimento fornecidos pelo usuário e necessários ao acesso a cada endpoint das APIs.
» expirationDateTime
string(date-time)
true
none
Data e hora de expiração da permissão. De preenchimento obrigatório, reflete a data limite de validade do consentimento. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
» transactionFromDateTime
string(date-time)
false
none
Data e hora da transação inicial. Se não for preenchido, a transação terá a data aberta e a data será retornada com a primeira transação disponível. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
» transactionToDateTime
string(date-time)
false
none
Data e hora final da transação. Se não for preenchido, a transação terá a data aberta e a data será retornada com a ultima transação disponível. Uma string com data e hora conforme especificação RFC-3339, sempre com a utilização de timezone UTC(UTC time format).
Identifica o recurso reportado pelo participante do Open Insurance, no caso de: Produtos de Titulos de Capitalização: policyNumber ou certificateNumber Produtos de Previdência: certificateNumber Produtos de Danos e Pessoas (independente do ramo e torná-lo como obrigatório): policyNumber ou certificateNumber
» type
string
true
none
Tipo de recurso (vide Enum): - CUSTOMERS_PERSONAL_IDENTIFICATIONS: Informações de identificação PF - CUSTOMERS_PERSONAL_QUALIFICATION: Informações de qualificação PF - CUSTOMERS_PERSONAL_ADITTIONALINFO: Informações complementares PF - CUSTOMERS_BUSINESS_IDENTIFICATIONS: Informações de identificação PJ - CUSTOMERS_BUSINESS_QUALIFICATION: Informações de qualificação PJ - CUSTOMERS_BUSINESS_ADITTIONALINFO: Informações complementares PJ - CAPITALIZATION_TITLES: Produtos de Titulos de Capitalização - PENSION_RISK: Produtos de Previdência Risco - DAMAGES_AND_PEOPLE_PATRIMONIAL: Produtos de Patrimonial - DAMAGES_AND_PEOPLE_AERONAUTICAL: Produtos de Aeronáuticos - DAMAGES_AND_PEOPLE_NAUTICAL: Produtos de Marítimo - DAMAGES_AND_PEOPLE_NUCLEAR: Produtos de Nuclear - DAMAGES_AND_PEOPLE_OIL: Produtos de Petróleo - DAMAGES_AND_PEOPLE_RESPONSABILITY: Produtos de Responsabilidade - DAMAGES_AND_PEOPLE_TRANSPORT: Produtos de Transportes - DAMAGES_AND_PEOPLE_FINANCIAL_RISKS: Produtos de Riscos Financeiros - DAMAGES_AND_PEOPLE_RURAL: Produtos de Rural - DAMAGES_AND_PEOPLE_AUTO: Produtos de Automóveis - DAMAGES_AND_PEOPLE_HOUSING: Produtos de Habitacional - DAMAGES_AND_PEOPLE_PEOPLE: Produtos de Pessoas (Repartição simples) - DAMAGES_AND_PEOPLE_ACCEPTANCE_AND_BRANCHES_ABROAD: Aceitação e Sucursal no exterior
» status
string
true
none
- Tipo de status de recurso (vide Enum): - Available: Disponível - Unavailable: Indisponível - Temporarily Unavailable: Temporariamente Indisponível - Pending Authorisation: Pendente de Autorização
Objeto que reúne as informações relativas ao relacionamento do cliente junto à Instituição. Considera-se relacionamento as informações que permitam conhecer desde quando a pessoa consultada é cliente da instituição, bem como um indicador dos produtos e serviços que ela consome atualmente e seus representantes
Properties
Name
Type
Required
Restrictions
Description
updateDateTime
string(date-time)
true
none
Data e hora da atualização do bloco de Relacionamento, conforme especificação RFC-3339, formato UTC.
startDate
string(date)
false
none
Data mais antiga de início de relacionamento, considerando todos os contratos (vigentes e não vigentes). Os contratos não vigentes considerados devem contemplar, no mínimo o período indicado na Tabela 4.1.
relationshipBeginning
string(date)
true
none
Campo deve ser preenchido com a data da apólice/contrato vigente mais antiga.
productsServices
[object]
true
none
none
» contract
string
true
none
Campo deve conter todos os contratos do cliente nos últimos 12 meses (número da apólice individual ou contrato ou certificado ou bilhete)
Indicar para cada contrato, caso aplicável, o código do ramo, conforme listagem de códigos definida em regulamentação específica sobre contabilização em ramos. - Caso tipo de produto do contrato for “Seguros de Danos.
Lista dos representantes. De preenchimento obrigatório se houver representante.
BusinessIdentificationData
{"updateDateTime":"2021-05-21T08:30:00Z","businessId":"578-psd-71md6971kjh-2d414","brandName":"Organização A","companyInfo":{"cnpjNumber":"01773247000563","name":"Empresa da Organização A"},"businessName":"Luiza e Benjamin Assessoria Jurídica Ltda","businessTradeName":"Organização B","incorporationDate":"2012-05-21","document":{"businesscnpjNumber":"50685362006773","businessRegisterNumberOriginCountry":"string","country":"BRA","expirationDate":"2023-05-21"},"type":"PRIVADO","contact":{"postalAddresses":[{"address":"Av Naburo Ykesaki, 1270","additionalInfo":"Fundos","districtName":"Centro","townName":"Marília","countrySubDivision":"SP","postCode":"17500001","ibgeTownCode":"17500001","country":"Brasil","countryCode":"BRA","geographicCoordinates":{"latitude":"-23.5475000","longitude":"-46.6361100"}}],"phones":[{"countryCallingCode":"55","areaCode":"19","number":"29875132","phoneExtension":"932"}],"emails":[{"email":"nome@br.net"}]},"parties":[{"type":"SOCIO","civilName":"Juan Kaique Cláudio Fernandes","socialName":"string","startDate":"2014-05-21","shareholding":"0.510000","documentType":"CPF","documentNumber":"73677831148","documentCountry":"BRA","documentExpirationDate":"2021-05-21"}]}
Conjunto de informações relativas a Identificação ou seja a ação e o efeito de identificar de forma única a pessoa jurídica através de seus dados cadastrais
Properties
Name
Type
Required
Restrictions
Description
updateDateTime
string(date-time)
true
none
Data e hora da atualização do bloco, conforme especificação RFC-3339
businessId
string
false
none
Um identificador único e imutável usado para identificar o recurso cliente pessoa jurídica dentro da transmissora. Este identificador não tem significado para o cliente que deu o consentimento
brandName
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a 'marca' é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes
companyInfo
object
true
none
Informações referente a sociedade a qual a marca pertence.
» cnpjNumber
string
true
none
Número completo do CNPJ da instituição responsável pelo Cadastro - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. Deve-se ter apenas os números do CNPJ, sem máscara
» name
string
true
none
Nome da Instituição, pertencente à Marca, responsável pela Dependência
businessName
string
true
none
Razão social da empresa consultada é o termo registrado sob o qual uma pessoa jurídica (PJ) se individualiza e exerce suas atividades. Também pode ser chamada por denominação social ou firma empresarial
businessTradeName
string
false
none
Nome fantasia - Se Aplicável
incorporationDate
string(date)
false
none
Data de constituição, conforme especificação RFC-3339
Número completo do CPF. O CPF é o Cadastro de Pessoa natural. Ele é um documento feito pela Receita Federal e serve para identificar os contribuintes. O CPF é uma numeração com 11 dígitos, que só mudam por decisão judicial. O documento é emitido pela receita federal
civilName
string
true
none
Nome civil completo da pessoa natural. (Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento, com o qual será identificada por toda a sua vida, bem como após a sua morte)
socialName
string
false
none
Nome social da pessoa natural, se houver. (aquele pelo qual travestis e transexuais se reconhecem, bem como são identificados por sua comunidade e em seu meio social, conforme Decreto Local).
Conjunto de informações referentes ao vínculo com uma pessoa.
Properties
Name
Type
Required
Restrictions
Description
type
string
false
none
Tipo de vínculo com a pessoa jurídica
civilName
string
false
none
Nome civil completo da pessoa natural (Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento, com o qual será identificada por toda a sua vida, bem como após a sua morte)
socialName
string
false
none
Nome social da pessoa natural, se houver. (aquele pelo qual travestis e transexuais se reconhecem, bem como são identificados por sua comunidade e em seu meio social, conforme Decreto Local).
startDate
string(date)
false
none
Data de início da participação, conforme especificação RFC-3339.
shareholding
string(double)
false
none
Percentual de participação societária (informar com 6 casas decimais). O Sócio só deve ser informado se sua participação societária for igual ou superior a 25%.
documentType
string
false
none
Tipo de documento de identificação do sócio ou administrador
documentNumber
string
false
none
Número do documento informado. Campo Texto Livre para preencher número e dígito do documento se houver
documentCountry
string
false
none
País de emissão do documento. Código do pais de acordo com o código alpha3 do ISO-3166.
documentExpirationDate
string(date)
false
none
Data de validade do documento informado, conforme especificação RFC-3339.
Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. p.ex. 'AC'. São consideradas apenas as siglas para os estados brasileiros
postCode
string
true
none
Código de Endereçamento Postal: Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios. p.ex. '01311000'.
ibgeTownCode
string
false
none
Código IBGE do município
country
string
true
none
none
countryCode
string
false
none
Código do pais de acordo com o código “alpha3” do ISO-3166.
Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. p.ex. 'AC'. São consideradas apenas as siglas para os estados brasileiros
postCode
string
true
none
Código de Endereçamento Postal: Composto por um conjunto numérico de oito dígitos, o objetivo principal do CEP é orientar e acelerar o encaminhamento, o tratamento e a entrega de objetos postados nos Correios, por meio da sua atribuição a localidades, logradouros, unidades dos Correios, serviços, órgãos públicos, empresas e edifícios. p.ex. '01311000'.
country
string
true
none
Código do pais de acordo com o código “alpha3” do ISO-3166.
EnumAreaCode
"19"
Número de DDD (Discagem Direta à Distância) do telefone do cliente - se houver
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Número de DDD (Discagem Direta à Distância) do telefone do cliente - se houver
Enumerated Values
Property
Value
anonymous
11
anonymous
12
anonymous
13
anonymous
14
anonymous
15
anonymous
16
anonymous
17
anonymous
18
anonymous
19
anonymous
21
anonymous
22
anonymous
24
anonymous
27
anonymous
28
anonymous
31
anonymous
32
anonymous
33
anonymous
34
anonymous
35
anonymous
37
anonymous
38
anonymous
41
anonymous
42
anonymous
43
anonymous
44
anonymous
45
anonymous
46
anonymous
47
anonymous
48
anonymous
49
anonymous
51
anonymous
53
anonymous
54
anonymous
55
anonymous
61
anonymous
62
anonymous
63
anonymous
64
anonymous
65
anonymous
66
anonymous
67
anonymous
68
anonymous
69
anonymous
71
anonymous
73
anonymous
74
anonymous
75
anonymous
77
anonymous
79
anonymous
81
anonymous
82
anonymous
83
anonymous
84
anonymous
85
anonymous
86
anonymous
87
anonymous
88
anonymous
89
anonymous
91
anonymous
92
anonymous
93
anonymous
94
anonymous
95
anonymous
96
anonymous
97
anonymous
98
anonymous
99
anonymous
NA
EnumCountrySubDivision
"SP"
Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. p.ex. 'AC'. São consideradas apenas as siglas para os estados brasileiros
Properties
Name
Type
Required
Restrictions
Description
anonymous
string
false
none
Enumeração referente a cada sigla da unidade da federação que identifica o estado ou o distrito federal, no qual o endereço está localizado. p.ex. 'AC'. São consideradas apenas as siglas para os estados brasileiros
Objeto agrupador de informações relativas a Documentos da pessoa natural
Properties
Name
Type
Required
Restrictions
Description
businesscnpjNumber
string
true
none
Número completo do CNPJ da Empresa consultada - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. Deve-se ter apenas os números do CNPJ, sem máscara Condicional ao Brasil no (BRA) campo País de emissão do documento de registro
businessRegisterNumberOriginCountry
string
false
none
Aplicável somente as pessoas jurídicas com domicílio ou sede no exterior desobrigadas de inscrição no CNPJ.
country
string
true
none
Código do pais de acordo com o código “alpha3” do ISO-3166.
expirationDate
string(date)
false
none
Data de vigência do documento de registro - conforme especificação RFC-3339.
Objeto que reúne as informações relativas ao relacionamento do cliente junto à Instituição. Considera-se relacionamento as informações que permitam conhecer desde quando a pessoa consultada é cliente da instituição, bem como um indicador dos produtos e serviços que ela consome atualmente e seus representantes
Properties
Name
Type
Required
Restrictions
Description
updateDateTime
string(date-time)
true
none
Data e hora da atualização do bloco de Relacionamento, conforme especificação RFC-3339, formato UTC.
startDate
string(date)
false
none
Data mais antiga de início de relacionamento, considerando todos os contratos (vigentes e não vigentes). Os contratos não vigentes considerados devem contemplar, no mínimo o período indicado na Tabela 4.1.
relationshipBeginning
string(date)
true
none
Campo deve ser preenchido com a data da apólice/contrato vigente mais antiga
productsServices
[object]
true
none
none
» contract
string
true
none
Campo deve conter todos os contratos do cliente nos últimos 12 meses (número da apólice individual ou contrato ou certificado ou bilhete)
Indicar para cada contrato, caso aplicável, o código do ramo, conforme listagem de códigos definida em regulamentação específica sobre contabilização em ramos. Obs - Caso tipo de produto do contrato for “Seguros de Danos”
Conjunto de informações relativas a Identificação ou seja a ação e o efeito de identificar de forma única a pessoa natural através de seus dados cadastrais.
Properties
Name
Type
Required
Restrictions
Description
updateDateTime
string(date-time)
true
none
Data e hora da atualização do bloco, conforme especificação RFC-3339
personalId
string
false
none
Um identificador único e imutável usado para identificar o recurso cliente pessoa natural dentro da transmissora. Este identificador não tem significado para o cliente que deu o consentimento
brandName
string
true
none
Nome da Marca reportada pelo participante do Open Insurance. O conceito a que se refere a marca é em essência uma promessa da empresa em fornecer uma série específica de atributos, benefícios e serviços uniformes aos clientes
civilName
string
true
none
Nome civil completo da pessoa natural (Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento, com o qual será identificada por toda a sua vida, bem como após a sua morte)
socialName
string
false
none
Nome social da pessoa natural, se houver. (aquele pelo qual travestis e transexuais se reconhecem, bem como são identificados por sua comunidade e em seu meio social, conforme Decreto Local).
cpfNumber
string
true
none
Número completo do CPF. Atributo que corresponde às informações mínimas exigidas pela Regulamentação em vigor. O CPF é o Cadastro de Pessoa natural. Ele é um documento feito pela Receita Federal e serve para identificar os contribuintes. O CPF é uma numeração com 11 dígitos, que só mudam por decisão judicial. O documento é emitido pela receita federal Condicional a seleção de true em hasBrazilianNationality
companyInfo
object
true
none
Informações referente a sociedade a qual a marca pertence.
» cnpjNumber
string
true
none
Número completo do CNPJ da instituição responsável pelo Cadastro - o CNPJ corresponde ao número de inscrição no Cadastro de Pessoa Jurídica. Deve-se ter apenas os números do CNPJ, sem máscara
» name
string
true
none
Nome da Instituição, pertencente à Marca, responsável pela Dependência
Nome civil completo da pessoa relativa à filiação. (Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento, com o qual será identificada por toda a sua vida, bem como após a sua morte).
identificationDetails
object
false
none
Informações referente ao cônjuge.
» civilName
string
false
none
Nome civil completo da pessoa natural (Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento, com o qual será identificada por toda a sua vida, bem como após a sua morte)
» cpfNumber
string
false
none
Número completo do CPF. Atributo que corresponde às informações mínimas exigidas pela Regulamentação em vigor. O CPF é o Cadastro de Pessoa natural. Ele é um documento feito pela Receita Federal e serve para identificar os contribuintes. O CPF é uma numeração com 11 dígitos, que só mudam por decisão judicial. O documento é emitido pela receita federal Condicional a seleção de true em hasBrazilianNationality
Número completo do CPF. O CPF é o Cadastro de Pessoa natural. Ele é um documento feito pela Receita Federal e serve para identificar os contribuintes. O CPF é uma numeração com 11 dígitos, que só mudam por decisão judicial. O documento é emitido pela receita federal
civilName
string
true
none
Nome civil completo da pessoa natural. (Direito fundamental da pessoa, o nome civil é aquele atribuído à pessoa natural desde o registro de seu nascimento, com o qual será identificada por toda a sua vida, bem como após a sua morte)
socialName
string
false
none
Nome social da pessoa natural, se houver. (aquele pelo qual travestis e transexuais se reconhecem, bem como são identificados por sua comunidade e em seu meio social, conforme Decreto Local).
[Objeto que reúne as informações relativas ao relacionamento do cliente junto à Instituição. Considera-se relacionamento as informações que permitam conhecer desde quando a pessoa consultada é cliente da instituição, bem como um indicador dos produtos e serviços que ela consome atualmente e seus representantes]
[Conjunto de informações relativas a Identificação ou seja a ação e o efeito de identificar de forma única a pessoa jurídica através de seus dados cadastrais]
[Objeto que reúne as informações relativas ao relacionamento do cliente junto à Instituição. Considera-se relacionamento as informações que permitam conhecer desde quando a pessoa consultada é cliente da instituição, bem como um indicador dos produtos e serviços que ela consome atualmente e seus representantes]
[Conjunto de informações relativas a Identificação ou seja a ação e o efeito de identificar de forma única a pessoa natural através de seus dados cadastrais.]
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"OUTRAS","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"OUTRAS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"riskCountry":"BRA","hasForum":true,"forumDescription":"string","transferorId":"12345678912","transferorName":"Nome Sobrenome","groupBranches":[111]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-acceptance-and-branches-abroad/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-acceptance-and-branches-abroad/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-acceptance-and-branches-abroad/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-acceptance-and-branches-abroad/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-acceptance-and-branches-abroad/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"OUTRAS","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"OUTRAS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"riskCountry":"BRA","hasForum":true,"forumDescription":"string","transferorId":"12345678912","transferorName":"Nome Sobrenome","groupBranches":[111]}}
Properties
Name
Type
Required
Restrictions
Description
documentType
string
true
none
Tipo de Documento Emitido
policyId
string
true
none
Identificador da apólice ou bilhete
susepProcessNumber
string
false
none
Número SUSEP da apólice, conforme regulamentação vigente (Obrigatório caso apólice com coberturas do ramo Garantia)
groupCertificateId
string
false
none
Identificador do Certificado(Caso Tipo de Documento Emitido for certificado)
issuanceType
string
true
none
Tipo de Emissão
issuanceDate
string(date)
true
none
Data de emissão do documento
termStartDate
string(date)
true
none
Data de início de vigência do documento
termEndDate
string(date)
true
none
Data de fim de vigência do documento
leadInsurerCode
string
false
none
Código da seguradora líder para contratos com arranjo de cosseguro
leadInsurerPolicyId
string
false
none
Identificador da apólice seguradora líder para apólice de cosseguro aceito
Limite máximo de indenização (LMI) é sublimite (Caso aplicável)
termStartDate
string(date)
true
none
Data de início de vigência da cobertura
termEndDate
string(date)
true
none
Data de fim de vigência da cobertura
isMainCoverage
boolean
false
none
Cobertura Principal
feature
string
true
none
Característica da cobertura
type
string
true
none
Tipo de cobertura
gracePeriod
integer
false
none
Período de carência. OBS: Obrigatório, se houver
gracePeriodicity
string
false
none
Periodicidade da carência. OBS: Obrigatório, se houver
gracePeriodCountingMethod
string
false
none
Indicador de dias úteis ou corridos da carência. OBS: Obrigatório, se houver
gracePeriodStartDate
string(date)
false
none
Data de início da carência. OBS: Obrigatório, se houver
gracePeriodEndDate
string(date)
false
none
Data de fim da carência. OBS: Obrigatório, se houver
Enumerated Values
Property
Value
code
OUTRAS
feature
MASSIFICADOS
feature
MASSIFICADOS_MICROSEGUROS
feature
GRANDES_RISCOS
type
PARAMETRICO
type
INTERMITENTE
type
REGULAR_COMUM
type
CAPITAL_GLOBAL
type
PARAMETRICO_E_INTERMITENTE
gracePeriodicity
DIA
gracePeriodicity
MES
gracePeriodicity
ANO
gracePeriodCountingMethod
DIAS_UTEIS
gracePeriodCountingMethod
DIAS_CORRIDOS
InsuranceAcceptanceAndBranchesAbroadCoverage
{"branch":111,"code":"OUTRAS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}
Properties
Name
Type
Required
Restrictions
Description
branch
string
true
none
Grupo e ramo da cobertura
code
string
true
none
Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
description
string
false
none
Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"}
Properties
Name
Type
Required
Restrictions
Description
type
string
true
none
Tipo de Franquia
typeAdditionalInfo
string
false
none
Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
Indicador de Dias Úteis ou Corridos (Caso aplicável)
periodStartDate
string(date)
true
none
Data de Início da Franquia
periodEndDate
string(date)
true
none
Data de Fim da Franquia
description
string
true
none
Descrição da Franquia
Enumerated Values
Property
Value
type
REDUZIDA
type
NORMAL
type
MAJORADA
type
DEDUTIVEL
type
OUTROS
periodicity
DIA
periodicity
MES
periodicity
ANO
periodCountingMethod
DIAS_UTEIS
periodCountingMethod
DIAS_CORRIDOS
POS
{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}
Valor total bruto do sinistro considerando todos os movimentos e suas reavaliações. Não devem ser considerados valores de deduções (por exemplo, redutores e ressarcimento salvado)
denialJustification
string
false
none
Justificativa da Negativa(Caso Status do Sinistro for 'ENCERRADO_SEM_INDENIZACAO')
denialJustificationDescription
string
false
none
Descrição da Justificativa da Negativa(Caso Justificativa da Negativa for 'OUTROS')
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","hasExactVehicleIdentification":true,"modality":"VALOR_DE_MERCADO_REFERENCIADO","amountReferenceTable":"MOLICAR","model":"string","year":"stri","fareCategory":"10","riskPostCode":"10000000","vehicleUsage":"LAZER","frequentDestinationPostCode":"10000000","overnightPostCode":"10000000","coverages":[{"branch":111,"code":"CASCO_COMPREENSIVA","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD","adjustmentRate":10,"premiumAmount":{"amount":2000,"currency":"BRL"},"compensationType":"PARCIAL","partialCompensationPercentage":10,"percentageOverLMI":10,"daysForTotalCompensation":0,"boundCoverage":"VEICULO"}]}],"coverages":[{"branch":111,"code":"CASCO_COMPREENSIVA","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo","hasDeductibleOverTotalCompensation":true},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"repairNetwork":"REDE_REFERENCIADA","repairedPartsUsageType":"NOVA_E_USADA","repairedPartsClassification":"ORIGINAL_E_COMPATIVEL","repairedPartsNationality":"NACIONAL_E_IMPORTADA","validityType":"SEMESTRAL_INTERMITENTE","otherCompensations":"string","otherBenefits":"DESCONTOS","assistancePackages":"ATE_DEZ_SERVICOS","isExpiredRiskPolicy":true,"bonusDiscountRate":0,"bonusClass":"string","drivers":[{"identification":"12345678900","sex":"MASCULINO","birthDate":"AAAA-MM-DD","licensedExperience":4}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-auto/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-auto/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-auto/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-auto/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-auto/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","hasExactVehicleIdentification":true,"modality":"VALOR_DE_MERCADO_REFERENCIADO","amountReferenceTable":"MOLICAR","model":"string","year":"stri","fareCategory":"10","riskPostCode":"10000000","vehicleUsage":"LAZER","frequentDestinationPostCode":"10000000","overnightPostCode":"10000000","coverages":[{"branch":111,"code":"CASCO_COMPREENSIVA","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD","adjustmentRate":10,"premiumAmount":{"amount":2000,"currency":"BRL"},"compensationType":"PARCIAL","partialCompensationPercentage":10,"percentageOverLMI":10,"daysForTotalCompensation":0,"boundCoverage":"VEICULO"}]}],"coverages":[{"branch":111,"code":"CASCO_COMPREENSIVA","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo","hasDeductibleOverTotalCompensation":true},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"repairNetwork":"REDE_REFERENCIADA","repairedPartsUsageType":"NOVA_E_USADA","repairedPartsClassification":"ORIGINAL_E_COMPATIVEL","repairedPartsNationality":"NACIONAL_E_IMPORTADA","validityType":"SEMESTRAL_INTERMITENTE","otherCompensations":"string","otherBenefits":"DESCONTOS","assistancePackages":"ATE_DEZ_SERVICOS","isExpiredRiskPolicy":true,"bonusDiscountRate":0,"bonusClass":"string","drivers":[{"identification":"12345678900","sex":"MASCULINO","birthDate":"AAAA-MM-DD","licensedExperience":4}]}
Properties
Name
Type
Required
Restrictions
Description
documentType
string
true
none
Tipo de Documento Emitido
policyId
string
true
none
Identificador da apólice ou bilhete
susepProcessNumber
string
false
none
Número SUSEP da apólice, conforme regulamentação vigente (Obrigatório caso apólice com coberturas do ramo Garantia)
groupCertificateId
string
false
none
Identificador do Certificado(Caso Tipo de Documento Emitido for certificado)
issuanceType
string
true
none
Tipo de Emissão
issuanceDate
string(date)
true
none
Data de emissão do documento
termStartDate
string(date)
true
none
Data de início de vigência do documento
termEndDate
string(date)
true
none
Data de fim de vigência do documento
leadInsurerCode
string
false
none
Código da seguradora líder para contratos com arranjo de cosseguro
leadInsurerPolicyId
string
false
none
Identificador da apólice seguradora líder para apólice de cosseguro aceito
Descrição do tipo do objeto segurado(caso tipo de objeto segurado for outros).
description
string
true
none
Descrição do objeto segurado
hasExactVehicleIdentification
boolean
false
none
Identificação exata do veículo (Casco, RCF-A, APP, Assistência e Outras Coberturas)
modality
string
false
none
Modalidade de cobertura (para cobertura Casco)
amountReferenceTable
string
false
none
Tabela de referência adotada no plano (Casco, RCF-A, APP, Assistência e Outras Coberturas)
model
string
false
none
Código do modelo (caso aplicável)
year
string
false
none
Ano do modelo (caso aplicável)
fareCategory
string
false
none
Categoria tarifária (Casco, RCF-A, APP, Assistência e Outras Coberturas; caso aplicável) - Conforme definido na tabela 9.9 do Manual de Orientação para Envio de Dados, Circular Susep nº 522
riskPostCode
string
false
none
CEP de risco (caso aplicável)
vehicleUsage
string
false
none
Código de utilização do veículo (Casco, RCF-A, APP, Assistência e Outras Coberturas; caso aplicável)
frequentDestinationPostCode
string
false
none
CEP da localidade de destino frequente do veículo (caso aplicável)
overnightPostCode
string
false
none
CEP da localidade de pernoite do veículo (caso aplicável)
{"branch":111,"code":"CASCO_COMPREENSIVA","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo","hasDeductibleOverTotalCompensation":true},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}
Properties
Name
Type
Required
Restrictions
Description
branch
string
true
none
Grupo e ramo da cobertura
code
string
true
none
Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
description
string
false
none
Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo","hasDeductibleOverTotalCompensation":true}
Properties
Name
Type
Required
Restrictions
Description
type
string
true
none
Tipo de Franquia
typeAdditionalInfo
string
false
none
Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
Indicador de Dias Úteis ou Corridos (caso aplicável)
periodStartDate
string(date)
false
none
Data de Início da Franquia (caso aplicável)
periodEndDate
string(date)
false
none
Data de Fim da Franquia (caso aplicável)
description
string
false
none
Descrição da Franquia (caso aplicável)
hasDeductibleOverTotalCompensation
boolean
false
none
Indicador de Franquia sobre indenização integral (caso aplicável)
Enumerated Values
Property
Value
type
REDUZIDA
type
NORMAL
type
MAJORADA
type
DEDUTIVEL
type
OUTROS
periodicity
DIA
periodicity
MES
periodicity
ANO
periodCountingMethod
DIAS_UTEIS
periodCountingMethod
DIAS_CORRIDOS
InsuranceAutoPOS
{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}
Valor total bruto do sinistro considerando todos os movimentos e suas reavaliações. Não devem ser considerados valores de deduções (por exemplo, redutores e ressarcimento salvado)
denialJustification
string
false
none
Justificativa da Negativa(Caso Status do Sinistro for 'ENCERRADO_SEM_INDENIZACAO')
denialJustificationDescription
string
false
none
Descrição da Justificativa da Negativa(Caso Justificativa da Negativa for 'OUTROS')
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"CASCO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"CASCO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-aviation/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-aviation/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-aviation/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-aviation/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-aviation/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"CASCO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"CASCO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]}
Properties
Name
Type
Required
Restrictions
Description
documentType
string
true
none
Tipo de Documento Emitido
policyId
string
true
none
Identificador da apólice ou bilhete
susepProcessNumber
string
false
none
Número SUSEP da apólice, conforme regulamentação vigente (Obrigatório caso apólice com coberturas do ramo Garantia)
groupCertificateId
string
false
none
Identificador do Certificado(Caso Tipo de Documento Emitido for certificado)
issuanceType
string
true
none
Tipo de Emissão
issuanceDate
string(date)
true
none
Data de emissão do documento
termStartDate
string(date)
true
none
Data de início de vigência do documento
termEndDate
string(date)
true
none
Data de fim de vigência do documento
leadInsurerCode
string
false
none
Código da seguradora líder para contratos com arranjo de cosseguro
leadInsurerPolicyId
string
false
none
Identificador da apólice seguradora líder para apólice de cosseguro aceito
{"branch":111,"code":"CASCO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}
Properties
Name
Type
Required
Restrictions
Description
branch
string
true
none
Grupo e ramo da cobertura
code
string
true
none
Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
description
string
false
none
Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"}
Properties
Name
Type
Required
Restrictions
Description
type
string
true
none
Tipo de Franquia
typeAdditionalInfo
string
false
none
Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
Indicador de Dias Úteis ou Corridos (Caso aplicável)
periodStartDate
string(date)
true
none
Data de Início da Franquia
periodEndDate
string(date)
true
none
Data de Fim da Franquia
description
string
true
none
Descrição da Franquia
Enumerated Values
Property
Value
type
REDUZIDA
type
NORMAL
type
MAJORADA
type
DEDUTIVEL
type
OUTROS
periodicity
DIA
periodicity
MES
periodicity
ANO
periodCountingMethod
DIAS_UTEIS
periodCountingMethod
DIAS_CORRIDOS
POS
{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}
Valor total bruto do sinistro considerando todos os movimentos e suas reavaliações. Não devem ser considerados valores de deduções (por exemplo, redutores e ressarcimento salvado)
denialJustification
string
false
none
Justificativa da Negativa(Caso Status do Sinistro for 'ENCERRADO_SEM_INDENIZACAO')
denialJustificationDescription
string
false
none
Descrição da Justificativa da Negativa(Caso Justificativa da Negativa for 'OUTROS')
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"PROTECAO_DE_BENS","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"PROTECAO_DE_BENS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"userGroup":"string","technicalSurplus":10}},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-financial-risk/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-financial-risk/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-financial-risk/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-financial-risk/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-financial-risk/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"PROTECAO_DE_BENS","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"PROTECAO_DE_BENS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"userGroup":"string","technicalSurplus":10}}
Properties
Name
Type
Required
Restrictions
Description
documentType
string
true
none
Tipo de Documento Emitido
policyId
string
true
none
Identificador da apólice ou bilhete
susepProcessNumber
string
false
none
Número SUSEP da apólice, conforme regulamentação vigente (Obrigatório caso apólice com coberturas do ramo Garantia)
groupCertificateId
string
false
none
Identificador do Certificado(Caso Tipo de Documento Emitido for certificado)
issuanceType
string
true
none
Tipo de Emissão
issuanceDate
string(date)
true
none
Data de emissão do documento
termStartDate
string(date)
true
none
Data de início de vigência do documento
termEndDate
string(date)
true
none
Data de fim de vigência do documento
leadInsurerCode
string
false
none
Código da seguradora líder para contratos com arranjo de cosseguro
leadInsurerPolicyId
string
false
none
Identificador da apólice seguradora líder para apólice de cosseguro aceito
{"branch":111,"code":"PROTECAO_DE_BENS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}
Properties
Name
Type
Required
Restrictions
Description
branch
string
true
none
Grupo e ramo da cobertura
code
string
true
none
Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
description
string
false
none
Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"}
Properties
Name
Type
Required
Restrictions
Description
type
string
true
none
Tipo de Franquia
typeAdditionalInfo
string
false
none
Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
Indicador de Dias Úteis ou Corridos (Caso aplicável)
periodStartDate
string(date)
true
none
Data de Início da Franquia
periodEndDate
string(date)
true
none
Data de Fim da Franquia
description
string
true
none
Descrição da Franquia
Enumerated Values
Property
Value
type
REDUZIDA
type
NORMAL
type
MAJORADA
type
DEDUTIVEL
type
OUTROS
periodicity
DIA
periodicity
MES
periodicity
ANO
periodCountingMethod
DIAS_UTEIS
periodCountingMethod
DIAS_CORRIDOS
POS
{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}
Valor total bruto do sinistro considerando todos os movimentos e suas reavaliações. Não devem ser considerados valores de deduções (por exemplo, redutores e ressarcimento salvado)
denialJustification
string
false
none
Justificativa da Negativa(Caso Status do Sinistro for 'ENCERRADO_SEM_INDENIZACAO')
denialJustificationDescription
string
false
none
Descrição da Justificativa da Negativa(Caso Justificativa da Negativa for 'OUTROS')
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"BASICA","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"BASICA","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-nautical/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-nautical/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-nautical/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-nautical/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-nautical/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"BASICA","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"BASICA","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]}
Properties
Name
Type
Required
Restrictions
Description
documentType
string
true
none
Tipo de Documento Emitido
policyId
string
true
none
Identificador da apólice ou bilhete
susepProcessNumber
string
false
none
Número SUSEP da apólice, conforme regulamentação vigente (Obrigatório caso apólice com coberturas do ramo Garantia)
groupCertificateId
string
false
none
Identificador do Certificado(Caso Tipo de Documento Emitido for certificado)
issuanceType
string
true
none
Tipo de Emissão
issuanceDate
string(date)
true
none
Data de emissão do documento
termStartDate
string(date)
true
none
Data de início de vigência do documento
termEndDate
string(date)
true
none
Data de fim de vigência do documento
leadInsurerCode
string
false
none
Código da seguradora líder para contratos com arranjo de cosseguro
leadInsurerPolicyId
string
false
none
Identificador da apólice seguradora líder para apólice de cosseguro aceito
{"branch":111,"code":"BASICA","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}
Properties
Name
Type
Required
Restrictions
Description
branch
string
true
none
Grupo e ramo da cobertura
code
string
true
none
Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
description
string
false
none
Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"}
Properties
Name
Type
Required
Restrictions
Description
type
string
true
none
Tipo de Franquia
typeAdditionalInfo
string
false
none
Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
Indicador de Dias Úteis ou Corridos (Caso aplicável)
periodStartDate
string(date)
true
none
Data de Início da Franquia
periodEndDate
string(date)
true
none
Data de Fim da Franquia
description
string
true
none
Descrição da Franquia
Enumerated Values
Property
Value
type
REDUZIDA
type
NORMAL
type
MAJORADA
type
DEDUTIVEL
type
OUTROS
periodicity
DIA
periodicity
MES
periodicity
ANO
periodCountingMethod
DIAS_UTEIS
periodCountingMethod
DIAS_CORRIDOS
POS
{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}
Valor total bruto do sinistro considerando todos os movimentos e suas reavaliações. Não devem ser considerados valores de deduções (por exemplo, redutores e ressarcimento salvado)
denialJustification
string
false
none
Justificativa da Negativa(Caso Status do Sinistro for 'ENCERRADO_SEM_INDENIZACAO')
denialJustificationDescription
string
false
none
Descrição da Justificativa da Negativa(Caso Justificativa da Negativa for 'OUTROS')
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"RISCOS_NUCLEARES","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"RISCOS_NUCLEARES","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-nuclear/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-nuclear/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-nuclear/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-nuclear/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-nuclear/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"RISCOS_NUCLEARES","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"RISCOS_NUCLEARES","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]}
Properties
Name
Type
Required
Restrictions
Description
documentType
string
true
none
Tipo de Documento Emitido
policyId
string
true
none
Identificador da apólice ou bilhete
susepProcessNumber
string
false
none
Número SUSEP da apólice, conforme regulamentação vigente (Obrigatório caso apólice com coberturas do ramo Garantia)
groupCertificateId
string
false
none
Identificador do Certificado(Caso Tipo de Documento Emitido for certificado)
issuanceType
string
true
none
Tipo de Emissão
issuanceDate
string(date)
true
none
Data de emissão do documento
termStartDate
string(date)
true
none
Data de início de vigência do documento
termEndDate
string(date)
true
none
Data de fim de vigência do documento
leadInsurerCode
string
false
none
Código da seguradora líder para contratos com arranjo de cosseguro
leadInsurerPolicyId
string
false
none
Identificador da apólice seguradora líder para apólice de cosseguro aceito
Limite máximo de indenização (LMI) é sublimite (Caso aplicável)
termStartDate
string(date)
true
none
Data de início de vigência da cobertura
termEndDate
string(date)
true
none
Data de fim de vigência da cobertura
isMainCoverage
boolean
false
none
Cobertura Principal
feature
string
true
none
Característica da cobertura
type
string
true
none
Tipo de cobertura
gracePeriod
integer
false
none
Período de carência. OBS: Obrigatório, se houver
gracePeriodicity
string
false
none
Periodicidade da carência. OBS: Obrigatório, se houver
gracePeriodCountingMethod
string
false
none
Indicador de dias úteis ou corridos da carência. OBS: Obrigatório, se houver
gracePeriodStartDate
string(date)
false
none
Data de início da carência. OBS: Obrigatório, se houver
gracePeriodEndDate
string(date)
false
none
Data de fim da carência. OBS: Obrigatório, se houver
Enumerated Values
Property
Value
code
RISCOS_NUCLEARES
code
OUTRAS
feature
MASSIFICADOS
feature
MASSIFICADOS_MICROSEGUROS
feature
GRANDES_RISCOS
type
PARAMETRICO
type
INTERMITENTE
type
REGULAR_COMUM
type
CAPITAL_GLOBAL
type
PARAMETRICO_E_INTERMITENTE
gracePeriodicity
DIA
gracePeriodicity
MES
gracePeriodicity
ANO
gracePeriodCountingMethod
DIAS_UTEIS
gracePeriodCountingMethod
DIAS_CORRIDOS
InsuranceNuclearCoverage
{"branch":111,"code":"RISCOS_NUCLEARES","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}
Properties
Name
Type
Required
Restrictions
Description
branch
string
true
none
Grupo e ramo da cobertura
code
string
true
none
Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
description
string
false
none
Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"}
Properties
Name
Type
Required
Restrictions
Description
type
string
true
none
Tipo de Franquia
typeAdditionalInfo
string
false
none
Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
Indicador de Dias Úteis ou Corridos (Caso aplicável)
periodStartDate
string(date)
true
none
Data de Início da Franquia
periodEndDate
string(date)
true
none
Data de Fim da Franquia
description
string
true
none
Descrição da Franquia
Enumerated Values
Property
Value
type
REDUZIDA
type
NORMAL
type
MAJORADA
type
DEDUTIVEL
type
OUTROS
periodicity
DIA
periodicity
MES
periodicity
ANO
periodCountingMethod
DIAS_UTEIS
periodCountingMethod
DIAS_CORRIDOS
POS
{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}
Valor total bruto do sinistro considerando todos os movimentos e suas reavaliações. Não devem ser considerados valores de deduções (por exemplo, redutores e ressarcimento salvado)
denialJustification
string
false
none
Justificativa da Negativa(Caso Status do Sinistro for 'ENCERRADO_SEM_INDENIZACAO')
denialJustificationDescription
string
false
none
Descrição da Justificativa da Negativa(Caso Justificativa da Negativa for 'OUTROS')
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"LUCRO_BRUTO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"LUCRO_BRUTO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"basicCoverageIndex":"SIMPLES","insuredObjects":[{"identification":"string","propertyType":"CASA","structuringType":"CONDOMINIO_VERTICAL","postCode":"10000000","businessActivity":"1234567"}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-patrimonial/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-patrimonial/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-patrimonial/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-patrimonial/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-patrimonial/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"LUCRO_BRUTO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"LUCRO_BRUTO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"basicCoverageIndex":"SIMPLES","insuredObjects":[{"identification":"string","propertyType":"CASA","structuringType":"CONDOMINIO_VERTICAL","postCode":"10000000","businessActivity":"1234567"}]}}
Properties
Name
Type
Required
Restrictions
Description
documentType
string
true
none
Tipo de Documento Emitido
policyId
string
true
none
Identificador da apólice ou bilhete
susepProcessNumber
string
false
none
Número SUSEP da apólice, conforme regulamentação vigente (Obrigatório caso apólice com coberturas do ramo Garantia)
groupCertificateId
string
false
none
Identificador do Certificado(Caso Tipo de Documento Emitido for certificado)
issuanceType
string
true
none
Tipo de Emissão
issuanceDate
string(date)
true
none
Data de emissão do documento
termStartDate
string(date)
true
none
Data de início de vigência do documento
termEndDate
string(date)
true
none
Data de fim de vigência do documento
leadInsurerCode
string
false
none
Código da seguradora líder para contratos com arranjo de cosseguro
leadInsurerPolicyId
string
false
none
Identificador da apólice seguradora líder para apólice de cosseguro aceito
{"branch":111,"code":"LUCRO_BRUTO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}
Properties
Name
Type
Required
Restrictions
Description
branch
string
true
none
Grupo e ramo da cobertura
code
string
true
none
Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
description
string
false
none
Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"}
Properties
Name
Type
Required
Restrictions
Description
type
string
true
none
Tipo de Franquia
typeAdditionalInfo
string
false
none
Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
Indicador de Dias Úteis ou Corridos (Caso aplicável)
periodStartDate
string(date)
true
none
Data de Início da Franquia
periodEndDate
string(date)
true
none
Data de Fim da Franquia
description
string
true
none
Descrição da Franquia
Enumerated Values
Property
Value
type
REDUZIDA
type
NORMAL
type
MAJORADA
type
DEDUTIVEL
type
OUTROS
periodicity
DIA
periodicity
MES
periodicity
ANO
periodCountingMethod
DIAS_UTEIS
periodCountingMethod
DIAS_CORRIDOS
POS
{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}
Valor total bruto do sinistro considerando todos os movimentos e suas reavaliações. Não devem ser considerados valores de deduções (por exemplo, redutores e ressarcimento salvado)
denialJustification
string
false
none
Justificativa da Negativa(Caso Status do Sinistro for 'ENCERRADO_SEM_INDENIZACAO')
denialJustificationDescription
string
false
none
Descrição da Justificativa da Negativa(Caso Justificativa da Negativa for 'OUTROS')
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"RISCOS_DE_PETROLEO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"RISCOS_DE_PETROLEO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-petroleum/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-petroleum/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-petroleum/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-petroleum/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-petroleum/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"RISCOS_DE_PETROLEO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"RISCOS_DE_PETROLEO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}]}
Properties
Name
Type
Required
Restrictions
Description
documentType
string
true
none
Tipo de Documento Emitido
policyId
string
true
none
Identificador da apólice ou bilhete
susepProcessNumber
string
false
none
Número SUSEP da apólice, conforme regulamentação vigente (Obrigatório caso apólice com coberturas do ramo Garantia)
groupCertificateId
string
false
none
Identificador do Certificado(Caso Tipo de Documento Emitido for certificado)
issuanceType
string
true
none
Tipo de Emissão
issuanceDate
string(date)
true
none
Data de emissão do documento
termStartDate
string(date)
true
none
Data de início de vigência do documento
termEndDate
string(date)
true
none
Data de fim de vigência do documento
leadInsurerCode
string
false
none
Código da seguradora líder para contratos com arranjo de cosseguro
leadInsurerPolicyId
string
false
none
Identificador da apólice seguradora líder para apólice de cosseguro aceito
Limite máximo de indenização (LMI) é sublimite (Caso aplicável)
termStartDate
string(date)
true
none
Data de início de vigência da cobertura
termEndDate
string(date)
true
none
Data de fim de vigência da cobertura
isMainCoverage
boolean
false
none
Cobertura Principal
feature
string
true
none
Característica da cobertura
type
string
true
none
Tipo de cobertura
gracePeriod
integer
false
none
Período de carência. OBS: Obrigatório, se houver
gracePeriodicity
string
false
none
Periodicidade da carência. OBS: Obrigatório, se houver
gracePeriodCountingMethod
string
false
none
Indicador de dias úteis ou corridos da carência. OBS: Obrigatório, se houver
gracePeriodStartDate
string(date)
false
none
Data de início da carência. OBS: Obrigatório, se houver
gracePeriodEndDate
string(date)
false
none
Data de fim da carência. OBS: Obrigatório, se houver
Enumerated Values
Property
Value
code
RISCOS_DE_PETROLEO
code
OUTRAS
feature
MASSIFICADOS
feature
MASSIFICADOS_MICROSEGUROS
feature
GRANDES_RISCOS
type
PARAMETRICO
type
INTERMITENTE
type
REGULAR_COMUM
type
CAPITAL_GLOBAL
type
PARAMETRICO_E_INTERMITENTE
gracePeriodicity
DIA
gracePeriodicity
MES
gracePeriodicity
ANO
gracePeriodCountingMethod
DIAS_UTEIS
gracePeriodCountingMethod
DIAS_CORRIDOS
InsurancePetroleumCoverage
{"branch":111,"code":"RISCOS_DE_PETROLEO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}
Properties
Name
Type
Required
Restrictions
Description
branch
string
true
none
Grupo e ramo da cobertura
code
string
true
none
Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
description
string
false
none
Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"}
Properties
Name
Type
Required
Restrictions
Description
type
string
true
none
Tipo de Franquia
typeAdditionalInfo
string
false
none
Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
Indicador de Dias Úteis ou Corridos (Caso aplicável)
periodStartDate
string(date)
true
none
Data de Início da Franquia
periodEndDate
string(date)
true
none
Data de Fim da Franquia
description
string
true
none
Descrição da Franquia
Enumerated Values
Property
Value
type
REDUZIDA
type
NORMAL
type
MAJORADA
type
DEDUTIVEL
type
OUTROS
periodicity
DIA
periodicity
MES
periodicity
ANO
periodCountingMethod
DIAS_UTEIS
periodCountingMethod
DIAS_CORRIDOS
POS
{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}
Valor total bruto do sinistro considerando todos os movimentos e suas reavaliações. Não devem ser considerados valores de deduções (por exemplo, redutores e ressarcimento salvado)
denialJustification
string
false
none
Justificativa da Negativa(Caso Status do Sinistro for 'ENCERRADO_SEM_INDENIZACAO')
denialJustificationDescription
string
false
none
Descrição da Justificativa da Negativa(Caso Justificativa da Negativa for 'OUTROS')
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"DANOS_CAUSADOS_A_TERCEIROS","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"DANOS_CAUSADOS_A_TERCEIROS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"coverages":[{"branch":111,"code":"DANOS_CAUSADOS_A_TERCEIROS","description":"string","type":"POR_OCORRENCIA","typeDescription":"string","retroactivityDate":"AAAA-MM-DD","retroactivityPeriod":"string","retroactivityTimeUnit":"DIA","retroactivityWorkingDaysIndex":"DIAS_UTEIS","complementaryTermStartDate":"AAAA-MM-DD","complementaryTermEndDate":"AAAA-MM-DD","complementaryTerm":"string","complementaryTermTimeUnit":"DIA","complementaryTermWorkingDaysIndex":"DIAS_UTEIS","supplementaryTermStartDate":"AAAA-MM-DD","supplementaryTermEndDate":"AAAA-MM-DD","supplementaryTerm":"string","supplementaryTermTimeUnit":"DIA","supplementaryTermWorkingDaysIndex":"DIAS_UTEIS","lawyerRecommendation":"ESCOLHIDO_PELO_SEGURADO","lawyerRecommendationDescription":"string"}],"insuredObjects":[{"identification":"string","hasComplementaryContract":true,"complementaryContractAmount":{"amount":2000,"currency":"BRL"},"coveragesMaxAmount":{"amount":2000,"currency":"BRL"},"coveragesTermStartDate":"AAAA-MM-DD","coveragesTermEndDate":"AAAA-MM-DD","coveragesTerm":100,"coveragesUnit":"DIA","coveragesWorkingDaysIndex":"DIAS_UTEIS","hasTransportationPollutionDamage":true,"hasThirdPatyDamage":true,"professionalClass":"ADMINISTRADOR_IMOBILIARIO","hasRetroactivityApplication":true}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-responsibility/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-responsibility/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-responsibility/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-responsibility/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-responsibility/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"DANOS_CAUSADOS_A_TERCEIROS","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"DANOS_CAUSADOS_A_TERCEIROS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"coverages":[{"branch":111,"code":"DANOS_CAUSADOS_A_TERCEIROS","description":"string","type":"POR_OCORRENCIA","typeDescription":"string","retroactivityDate":"AAAA-MM-DD","retroactivityPeriod":"string","retroactivityTimeUnit":"DIA","retroactivityWorkingDaysIndex":"DIAS_UTEIS","complementaryTermStartDate":"AAAA-MM-DD","complementaryTermEndDate":"AAAA-MM-DD","complementaryTerm":"string","complementaryTermTimeUnit":"DIA","complementaryTermWorkingDaysIndex":"DIAS_UTEIS","supplementaryTermStartDate":"AAAA-MM-DD","supplementaryTermEndDate":"AAAA-MM-DD","supplementaryTerm":"string","supplementaryTermTimeUnit":"DIA","supplementaryTermWorkingDaysIndex":"DIAS_UTEIS","lawyerRecommendation":"ESCOLHIDO_PELO_SEGURADO","lawyerRecommendationDescription":"string"}],"insuredObjects":[{"identification":"string","hasComplementaryContract":true,"complementaryContractAmount":{"amount":2000,"currency":"BRL"},"coveragesMaxAmount":{"amount":2000,"currency":"BRL"},"coveragesTermStartDate":"AAAA-MM-DD","coveragesTermEndDate":"AAAA-MM-DD","coveragesTerm":100,"coveragesUnit":"DIA","coveragesWorkingDaysIndex":"DIAS_UTEIS","hasTransportationPollutionDamage":true,"hasThirdPatyDamage":true,"professionalClass":"ADMINISTRADOR_IMOBILIARIO","hasRetroactivityApplication":true}]}}
Properties
Name
Type
Required
Restrictions
Description
documentType
string
true
none
Tipo de Documento Emitido
policyId
string
true
none
Identificador da apólice ou bilhete
susepProcessNumber
string
false
none
Número SUSEP da apólice, conforme regulamentação vigente (Obrigatório caso apólice com coberturas do ramo Garantia)
groupCertificateId
string
false
none
Identificador do Certificado(Caso Tipo de Documento Emitido for certificado)
issuanceType
string
true
none
Tipo de Emissão
issuanceDate
string(date)
true
none
Data de emissão do documento
termStartDate
string(date)
true
none
Data de início de vigência do documento
termEndDate
string(date)
true
none
Data de fim de vigência do documento
leadInsurerCode
string
false
none
Código da seguradora líder para contratos com arranjo de cosseguro
leadInsurerPolicyId
string
false
none
Identificador da apólice seguradora líder para apólice de cosseguro aceito
{"branch":111,"code":"DANOS_CAUSADOS_A_TERCEIROS","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}
Properties
Name
Type
Required
Restrictions
Description
branch
string
true
none
Grupo e ramo da cobertura
code
string
true
none
Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
description
string
false
none
Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"}
Properties
Name
Type
Required
Restrictions
Description
type
string
true
none
Tipo de Franquia
typeAdditionalInfo
string
false
none
Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
Indicador de Dias Úteis ou Corridos (Caso aplicável)
periodStartDate
string(date)
true
none
Data de Início da Franquia
periodEndDate
string(date)
true
none
Data de Fim da Franquia
description
string
true
none
Descrição da Franquia
Enumerated Values
Property
Value
type
REDUZIDA
type
NORMAL
type
MAJORADA
type
DEDUTIVEL
type
OUTROS
periodicity
DIA
periodicity
MES
periodicity
ANO
periodCountingMethod
DIAS_UTEIS
periodCountingMethod
DIAS_CORRIDOS
POS
{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}
Valor total bruto do sinistro considerando todos os movimentos e suas reavaliações. Não devem ser considerados valores de deduções (por exemplo, redutores e ressarcimento salvado)
denialJustification
string
false
none
Justificativa da Negativa(Caso Status do Sinistro for 'ENCERRADO_SEM_INDENIZACAO')
denialJustificationDescription
string
false
none
Descrição da Justificativa da Negativa(Caso Justificativa da Negativa for 'OUTROS')
{"data":{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"GRANIZO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"GRANIZO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"insuredObjects":[{"identification":"string","isFESRParticipant":true,"subventionAmount":{"amount":2000,"currency":"BRL"},"subventionType":"AC","safeArea":2000,"unitMeasure":"HECTAR","cultureCode":11111111,"flockCode":"BOVINOS","forestCode":"PINUS","surveyDate":"AAAA-MM-DD","surveyAddress":"string","surveyCountrySubDivision":"SP","surveyPostCode":10000000,"surveyCountryCode":"BRA","surveyorIdType":"CPF","surveyorId":40,"surveyorName":"string","modelType":"CLIMATICOS","areAssetsCovered":true,"coveredAnimalDestination":"CONSUMO","animalType":"ELITE"}]}},"links":{"self":"https://api.organizacao.com.br/open-insurance/insurance-rural/v1","first":"https://api.organizacao.com.br/open-insurance/insurance-rural/v1","prev":"https://api.organizacao.com.br/open-insurance/insurance-rural/v1","next":"https://api.organizacao.com.br/open-insurance/insurance-rural/v1","last":"https://api.organizacao.com.br/open-insurance/insurance-rural/v1"},"meta":{"totalRecords":10,"totalPages":1}}
{"documentType":"APOLICE_INDIVIDUAL","policyId":"111111","susepProcessNumber":"string","groupCertificateId":"string","issuanceType":"EMISSAO_PROPRIA","issuanceDate":"AAAA-MM-DD","termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","leadInsurerCode":"string","leadInsurerPolicyId":"string","maxLMG":{"amount":2000,"currency":"BRL"},"proposalId":"string","insureds":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"beneficiaries":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"principals":[{"identification":"12345678900","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","email":"string","city":"string","state":"string","country":"BRA","address":"string"}],"intermediaries":[{"type":"REPRESENTANTE","identification":"12345678900","brokerId":"string","identificationType":"CPF","name":"Nome Sobrenome","postCode":"10000000","city":"string","state":"string","country":"BRA","address":"string"}],"insuredObjects":[{"identification":"string","type":"CONTRATO","typeAdditionalInfo":"string","description":"string","amount":{"amount":2000,"currency":"BRL"},"coverages":[{"branch":111,"code":"GRANIZO","description":"string","internalCode":"string","susepProcessNumber":"string","LMI":{"amount":2000,"currency":"BRL"},"isLMISublimit":true,"termStartDate":"AAAA-MM-DD","termEndDate":"AAAA-MM-DD","isMainCoverage":true,"feature":"MASSIFICADOS","type":"PARAMETRICO","gracePeriod":0,"gracePeriodicity":"DIA","gracePeriodCountingMethod":"DIAS_UTEIS","gracePeriodStartDate":"AAAA-MM-DD","gracePeriodEndDate":"AAAA-MM-DD"}]}],"coverages":[{"branch":111,"code":"GRANIZO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}],"coinsuranceRetainedPercentage":10,"coinsurers":[{"identification":"string","cededPercentage":10}],"branchInfo":{"insuredObjects":[{"identification":"string","isFESRParticipant":true,"subventionAmount":{"amount":2000,"currency":"BRL"},"subventionType":"AC","safeArea":2000,"unitMeasure":"HECTAR","cultureCode":11111111,"flockCode":"BOVINOS","forestCode":"PINUS","surveyDate":"AAAA-MM-DD","surveyAddress":"string","surveyCountrySubDivision":"SP","surveyPostCode":10000000,"surveyCountryCode":"BRA","surveyorIdType":"CPF","surveyorId":40,"surveyorName":"string","modelType":"CLIMATICOS","areAssetsCovered":true,"coveredAnimalDestination":"CONSUMO","animalType":"ELITE"}]}}
Properties
Name
Type
Required
Restrictions
Description
documentType
string
true
none
Tipo de Documento Emitido
policyId
string
true
none
Identificador da apólice ou bilhete
susepProcessNumber
string
false
none
Número SUSEP da apólice, conforme regulamentação vigente (Obrigatório caso apólice com coberturas do ramo Garantia)
groupCertificateId
string
false
none
Identificador do Certificado(Caso Tipo de Documento Emitido for certificado)
issuanceType
string
true
none
Tipo de Emissão
issuanceDate
string(date)
true
none
Data de emissão do documento
termStartDate
string(date)
true
none
Data de início de vigência do documento
termEndDate
string(date)
true
none
Data de fim de vigência do documento
leadInsurerCode
string
false
none
Código da seguradora líder para contratos com arranjo de cosseguro
leadInsurerPolicyId
string
false
none
Identificador da apólice seguradora líder para apólice de cosseguro aceito
{"branch":111,"code":"GRANIZO","description":"string","deductible":{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"},"POS":{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}}
Properties
Name
Type
Required
Restrictions
Description
branch
string
true
none
Grupo e ramo da cobertura
code
string
true
none
Código da cobertura, conforme Anexo II do Manuel de Escopo de Dados
description
string
false
none
Descrição / Nome da Cobertura (Caso Código da Cobertura for "OUTRAS")
{"type":"DEDUTIVEL","typeAdditionalInfo":"string","amount":{"amount":2000,"currency":"BRL"},"period":10,"periodicity":"DIA","periodCountingMethod":"DIAS_UTEIS","periodStartDate":"2022-05-16","periodEndDate":"2022-05-17","description":"Franquia de exemplo"}
Properties
Name
Type
Required
Restrictions
Description
type
string
true
none
Tipo de Franquia
typeAdditionalInfo
string
false
none
Descriçao do Tipo de Franquia (Caso Tipo de Franquia for "OUTROS")
Indicador de Dias Úteis ou Corridos (Caso aplicável)
periodStartDate
string(date)
true
none
Data de Início da Franquia
periodEndDate
string(date)
true
none
Data de Fim da Franquia
description
string
true
none
Descrição da Franquia
Enumerated Values
Property
Value
type
REDUZIDA
type
NORMAL
type
MAJORADA
type
DEDUTIVEL
type
OUTROS
periodicity
DIA
periodicity
MES
periodicity
ANO
periodCountingMethod
DIAS_UTEIS
periodCountingMethod
DIAS_CORRIDOS
POS
{"applicationType":"VALOR","description":"Descrição de exemplo","minValue":{"amount":2000,"currency":"BRL"},"maxValue":{"amount":2000,"currency":"BRL"},"percentage":10}
Valor total bruto do sinistro considerando todos os movimentos e suas reavaliações. Não devem ser considerados valores de deduções (por exemplo, redutores e ressarcimento salvado)
denialJustification
string
false
none
Justificativa da Negativa(Caso Status do Sinistro for 'ENCERRADO_SEM_INDENIZACAO')
denialJustificationDescription
string
false
none
Descrição da Justificativa da Negativa(Caso Justificativa da Negativa for 'OUTROS')